This method gives tools access to a component schema in memory for its operations. The tool calls this method when it requires a certain component schema loaded and made available to the tool adapter. For instance, during the Retrieve operation, the tool might access its own component schema. In such a scenario, the tool calls this method just before calling the Retrieve method to SmartPlant Common UI. The tool identifies the component schema to be loaded with its UID.
The tool’s SmartPlant Adapter must implement the interface ISPAdapter6 and its write-only property CompSchemaIContainer to get access to the component schema. SmartPlant Client sets the property to the component schema object after the tool calls LoadCompSchemaForAdapter. (For more information, see ISPAdapter6 Interface.)
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
sCompSchemaUID |
String |
Input |
The UID of the Component Schema to be loaded. |
Return Value
-
0 if method is successful.
-
A negative number if method fails (check the LastErrorMessage property for error message).
Comments
Tools must implement ISPAdapter6 interface before calling this method.