Connect to SmartPlant Foundation.
-
The design tool must call this method before calling any other method on this interface, except Register.
-
There are several signatures for Connect. If you are using SPCLCommonUIApplicationUI, do not use the signatures that contain pstrToolSPAdapterAssemblyPath and pstrToolSPAdapterTypeName. Use the signatures defined below:
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
sSPFURL |
String (maximum 128 characters) |
Input |
SmartPlant Foundation URL. |
|
sSPFPlant |
String (maximum 254 characters) |
Input |
SmartPlant Foundation Plant name. |
|
pstrSPFUserID |
String (maximum 256 characters) |
Input |
Not used in all signatures. SmartPlant Foundation log on user ID. |
|
pstrSPFUserPwd |
String (maximum 32 characters) |
Input |
Not used in all signatures. SmartPlant Foundation log on password. |
|
sToolID |
String (maximum 24 characters) |
Input |
Design tool name. For example, Smart P&ID. |
|
pobjToolSPAdapterAssemblyInformation |
ISPAssemblyInformation |
Input |
For SmartPlant Adapter class, information about an assembly that contains it, and an associated AppDomain, if any. |
|
oToolParameters |
ISPToolParameters |
Input |
Collection of tool parameters that are passed to the tool adapter. |
|
oToolDocsAssemblyInformation |
ISPAssemblyInformation |
Input |
Not used in all signatures. For tools that support ISPToolDocs and/or ISPToolDocs2 interfaces, information about an assembly that contains it, and an associated AppDomain. Calling the signature of Connect from which this parameter is omitted is the equivalent of passing nothing in this parameter, which should be done if the tool supports neither ISPTools nor ISPToolDocs2. |
|
bFileMode |
Boolean |
Input |
Indicates whether ‘Publish/Retrieve to File Mode’ must be turned on. |
Return Value
-
0 if method is successful.
-
A negative number if method fails (check the LastErrorMessage property for error message).
Comments
None.