The method to connect to a project in SmartPlant Foundation has four signatures.
In order to connect to projects instead of connect, the design tool must call the ConnectToProject method before calling any other method on this interface, except for Register.
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. |
pstrProjectNameInTool |
String (maximum 256 characters) |
Input |
Tool project name. This should match the project name in SmartPlant Foundation to establish a connection. |
pstrProjectNameInSPF |
String (maximum 256 characters) |
Input |
SmartPlant Foundation project name. This argument is kept as a place holder for future enhancements. The tools can ignore this argument. |
pstrSPFUserID |
String (maximum 256 characters) |
Input |
Not used in all signatures. SmartPlant Foundation logon user ID. |
pstrSPFUserPwd |
String (maximum 32 characters) |
Input |
Not used in all signatures. SmartPlant Foundation logon password. |
pstrToolID |
String (maximum 32 characters) |
Input |
Design tool name. For example, Smart P&ID. |
pstrToolSPAdapterAssemblyPath |
String |
Input |
Absolute path to SPAdapter assembly. |
pstrToolSPAdapterTypeName |
String |
Input |
SPAdapter type name. |
pobjToolParameters |
ISPToolParameters |
Input |
Not used in all signatures. 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. |
pobjToolDocsAssemblyInformation |
ISPAssemblyInformation |
Input |
For tools that support ISPToolDocs or ISPToolDocs2 interfaces, information about an assembly that contains it, and an associated AppDomain. Pass Nothing in this parameter if the tool supports neither ISPToolDocs nor ISPToolDocs2. |
pblnFileMode |
Boolean |
Input |
Indicates whether the Publish/Retrieve to File mode should be active. |
Return Value
-
0 if method is successful.
-
A negative number if the method fails (check the LastErrorMessage property for error message).
Comments
None.