|
Getting Started
SDK API Reference
SDK API Features
Other Documentation
|
|
|
The set of routines available in the Descriptor Registry Suite.
More...
#include <PIActions.h>
|
Data Fields |
SPAPI OSErr(* | Register )(const char *key, PIActionDescriptor descriptor, Boolean isPersistent) |
| Adds a descriptor to the registry.
|
SPAPI OSErr(* | Erase )(const char *key) |
| Removes a descriptor from the registry.
|
SPAPI OSErr(* | Get )(const char *key, PIActionDescriptor *descriptor) |
| Returns a descriptor from the registry.
|
Detailed Description
The set of routines available in the Descriptor Registry Suite.
Field Documentation
Adds a descriptor to the registry.
- Parameters:
-
| key | Unique string or ID. |
| descriptor | Descriptor with pertinent keys. See Action Descriptor Suite. |
| isPersistent | Indicates whether the descriptor is able to be saved and restored across invocations of the application. Useful for things like preferences. |
- Returns:
- Non-zero error if failure.
Removes a descriptor from the registry.
- Parameters:
-
- Returns:
- Non-zero error if failure. [???list of error types? invalid key? Key not present?]
Returns a descriptor from the registry.
- Parameters:
-
| key | The unique string ID for the descriptor to return. |
| descriptor | The descriptor returned. This is a copy, the plug-in must free the memory when it is done. See Action Descriptor Suite. |
- Returns:
- Non-zero error if failure.
The documentation for this struct was generated from the following file:
|
|