Provides routines for building references to objects, which allows the plug-in to get and set properties and target events from the Action Control Suite and the Basic Action Control Suite. More...

Data Structures
struct	PSActionReferenceProcs
	The set of routines available in the Action Reference Suite. More...
Defines
#define	kPSActionReferenceSuite "df135117-c769-11d0-8079-00c04fd7ec47"
	The unique identifier for the Action Reference Suite.
#define	kPSActionReferenceSuiteVersion 3
	The current version of the Action Reference Suite.
#define	kPSActionReferenceSuitePrevVersion 2
Typedefs
typedef struct PSActionReferenceProcs	PSActionReferenceProcs
	The set of routines available in the Action Reference Suite.

Detailed Description

Provides routines for building references to objects, which allows the plug-in to get and set properties and target events from the Action Control Suite and the Basic Action Control Suite.

These references can also be used to build descriptors and lists by the Action Descriptor Suite and Action List Suite.

Accessing the Suite

The Action Reference suite is referred to as:

  #define kPSActionReferenceSuite   "df135117-c769-11d0-8079-00c04fd7ec47"

with the version constant:

  #define   kPSActionReferenceSuiteVersion  2

The suite is acquired as follows:

  PSActionReferenceProcs *sPSActionReference;
  error = sSPBasic->AcquireSuite(kPSActionReferenceSuite,
                                 kPSActionReferenceSuiteVersion,
                                 &sPSActionReference);
  if (error) goto . . . //handle error

Or, alternatively, use the global variable sPSActionReference, by including the header file sampleCode\common\includes\PIUSuites.h.

For PICA errors, see SPErrorCodes.h.