LoadCompSchemaForAdapter As Long - Integration - Update 44 - Help - Hexagon

SmartPlant Integration COM Help

Language
English
Product
Integration
Search by Category
Help
SmartPlant Foundation / SDx Version
10
Smart P&ID Version
9 (2019)
Smart Engineering Manager Version
10 (2019)

This method is added for tools to have access to a component schema in memory for their operations. The tool will call 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 may need access to its own component schema. In such a case, the tool will call this method just before invoking retrieve call to EFCommonUI. The tool will identify the component schema to be loaded.

To make the component schema container available to tool adapter a new interface, called IEFAdapter9 is added, which has property CompSchemaIContainer for tools to implement. The tool Adapter implementation will have a local pointer to be set when the EFCommonUI calls this property after the component schema is loaded. (See IEFAdapter9 Interface for details.)

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 IEFAdapter9 interface before calling this method.