Getting Started

SDK API Reference

SDK API Features

Other Documentation

Action List Suite

Detailed Description

Allows a plug-in to get values from and put values into a list.

These lists can be used as values for Action Descriptors. See Action Descriptor Suite.

Accessing the Suite

The Action List suite is referred to as: 

  #define kPSActionListSuite    "df135116-c769-11d0-8079-00c04fd7ec47"
with the version constant: 
  #define   kPSActionListSuiteVersion   1
The suite is acquired as follows: 
  PSActionListProcs *sPSActionList;
  error = sSPBasic->AcquireSuite(kPSActionListSuite,
                                 kPSActionListSuiteVersion, 
                                 &sPSActionList);
  if (error) goto . . . //handle error
Or, alternatively, use the global variable sPSActionList, by including the header file sampleCode\common\includes\PIUSuites.h.

For PICA errors, see SPErrorCodes.h.


Data Structures

struct  PSActionListProcs
 The set of available routines for the Action List Suite. More...

Defines

#define kPSActionListSuite   "df135116-c769-11d0-8079-00c04fd7ec47"
 Unique identifier for the Action List Suite.
#define kPSActionListSuiteVersion   2
 Current version of the Action List Suite.
#define kPSActionListSuitePrevVersion   1

Define Documentation

#define kPSActionListSuite   "df135116-c769-11d0-8079-00c04fd7ec47"

Unique identifier for the Action List Suite.

#define kPSActionListSuiteVersion   2

Current version of the Action List Suite.

#define kPSActionListSuitePrevVersion   1