|
Getting Started
SDK API Reference
SDK API Features
Other Documentation
|
|
|
The set of routines available in the Basic Action Control Suite.
More...
#include <PIActions.h>
Detailed Description
The set of routines available in the Basic Action Control Suite.
Field Documentation
Gets a property from the host.
The actions system also serves as a database for properties; use the Get routine as a quick way to get properties from the host. - Parameters:
-
| result | [OUT] A descriptor with the pertinent information. The plug-in is responsible for freeing this descriptor, when it has finished using result . |
| reference | The property to get. The plug-in must build this reference to the object and the property by using the Action Reference Suite. |
- Returns:
- Non-zero error if failure.
Returns the runtime ID for a string.
- Parameters:
-
| stringID | string value to convert |
| typeID | [OUT] Four character runtime ID. |
- Returns:
- Non-zero error if failure.
Returns the string for an ID.
- Parameters:
-
| typeID | ID value to convert |
| stringID | {OUT} string value representing ID |
| stringLength | Maximum string length. |
- Returns:
- Non-zero error if failure.
Creates a new string with the same runtime ID as an existing string.
This is useful when the original string contains characters that aren't legal in C identifiers and thus can't be used in the various string- based descriptor calls. - Parameters:
-
| newStringID | The new string to create. |
| existingStringID | The string whose runtime ID the new string will share. |
- Returns:
- Non-zero error if failure.
The documentation for this struct was generated from the following file:
|
|