Detailed Description
The PluginItem class contains the information on each item of a plug-in.
A plug-in item is basically an XSI customizable component such as:
- Since:
- 4.0
#include <xsi_pluginitem.h>
List of all members.
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
in_ref | constant reference object. |
Copy constructor.
- Parameters:
-
in_obj | constant class object. |
Member Function Documentation
bool IsA |
( |
siClassID |
in_ClassID | ) |
const [virtual] |
Returns true if a given class type is compatible with this API class.
- Parameters:
-
- Returns:
- true if the class is compatible, false otherwise.
Reimplemented from SIObject.
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from SIObject.
Creates an object from another object. The new object is set to empty if the input object is not compatible.
- Parameters:
-
in_obj | constant class object. |
- Returns:
- The new PluginItem object.
Creates an object from a reference object. The new object is set to empty if the input reference object is not compatible.
- Parameters:
-
in_ref | constant class object. |
- Returns:
- The new PluginItem object.
Reimplemented from SIObject.
Sets the help path for this plug-in item
- Parameters:
-
- Returns:
- CStatus OK if successful
-
CStatus Fail if not successful
Sets the categories for this plug-in item
- Parameters:
-
in_strCat | A comma-separated string representing the categories of this plug-in item. |
- Returns:
- CStatus OK if successul
The documentation for this class was generated from the following file: