PSDescriptorRegistryProcs Struct Reference

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

SPAPI OSErr(* PSDescriptorRegistryProcs::Register)(const char *key, PIActionDescriptor descriptor, Boolean isPersistent)

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.

SPAPI OSErr(* PSDescriptorRegistryProcs::Erase)(const char *key)

Removes a descriptor from the registry.

Parameters:

key	Key to remove.

Returns:

Non-zero error if failure. [???list of error types? invalid key? Key not present?]

SPAPI OSErr(* PSDescriptorRegistryProcs::Get)(const char *key, PIActionDescriptor *descriptor)

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:

• PIActions.h