Connect to SmartPlant Foundation.
-
The design tool must call this method before calling any other method on this interface, except Register.
-
There are two signatures for Connect. If you are using SPCLCommonUIApplicationNoUI, do not use the signature that contains pstrToolSPAdapterAssemblyPath and pstrToolSPAdapterTypeName. Use the one defined below:
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
pstrSPFURL |
String (maximum 128 characters) |
Input |
SmartPlant Foundation URL. |
|
pstrSPFPlant |
String (maximum 254 characters) |
Input |
SmartPlant Foundation Plant name. |
|
pstrSPFUserID |
String (maximum 256 characters) |
Input |
SmartPlant Foundation login User ID. |
|
pstrSPFUserPwd |
String (maximum 32 characters) |
Input |
SmartPlant Foundation login password. |
|
pstrToolID |
String (maximum 32 characters) |
Input |
Design tool name. For example, Smart P&ID. |
|
pobjToolSPAdapterAssemblyInformation |
ISPAssemblyInformation |
Input |
Information about Adapter and its AppDomain, Adapter assembly path, and assembly type to create adapter object. |
|
pobjToolParameters |
ISPToolParameters |
Input |
Collection of tool parameters that, in turn, will be passed to the tool adapter. Arguments, such as tool site and tool plant as well as other tool specific parameters, can be passed using this argument. |
|
pblnFileMode |
Boolean |
Input |
Indicates whether ‘Publish/Retrieve to File Mode’ should 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.