Action Control Suite

Allows automation plug-ins to control playback and actions taken on events. More...

Data Structures
struct	PSActionControlProcs
	The set of routines available in the Action Control Suite. More...
Defines
#define	kPSActionControlSuite   "bc1e4d70-f953-11d0-8d9f-00c04fd5f7ee"
	Unique identifier for the Action Control Suite.
#define	kPSActionControlSuiteVersion   6
	Current version of the Action Control Suite, compatible with version 2.
#define	kPSActionControlSuiteVersion5   5
#define	kPSActionControlSuiteVersion4   4
#define	kPSActionControlSuiteVersion3   3
#define	kPSActionControlSuiteVersion2   2
Typedefs
typedef void(*	PIEventNotifier )(DescriptorEventID eventID, PIActionDescriptor descriptor, PIDialogRecordOptions options, void *data)
	The prototype for a plug-in routine that receives action event notification.
typedef void(*	PICommandNotifier )(uint32 commandID, OSErr result, DescriptorEventID eventID, PIActionDescriptor descriptor, PIDialogRecordOptions options, void *data)
	The prototype for a plug-in routine that receives a command completion notification associated with a PostCommand call.
typedef SPErr(*	PISuspendProc )(void *data)
	The prototype for a plug-in routine that plays actions that are not recorded to the Actions Palette.
typedef struct PSActionControlProcs	PSActionControlProcs
	The set of routines available in the Action Control Suite.

---

Detailed Description

Allows automation plug-ins to control playback and actions taken on events.

Available only in Automation plug-ins.

Accessing the Suite

The Action Control suite is referred to as:

  #define kPSActionControlSuite         "bc1e4d70-f953-11d0-8d9f-00c04fd5f7ee"

with the version constant:

  #define kPSActionControlSuiteVersion      3

The suite is acquired as follows:

  PSActionControlProcs *sPSActionControl;
  error = sSPBasic->AcquireSuite(kPSActionControlSuite,
                                 kPSActionControlSuiteVersion,
                                 &sPSActionControl);
  if (error) goto . . . //handle error

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

For PICA errors, see SPErrorCodes.h.

---

Define Documentation

#define kPSActionControlSuite   "bc1e4d70-f953-11d0-8d9f-00c04fd5f7ee"

Unique identifier for the Action Control Suite.

#define kPSActionControlSuiteVersion   6

Current version of the Action Control Suite, compatible with version 2.

#define kPSActionControlSuiteVersion5   5

#define kPSActionControlSuiteVersion4   4

#define kPSActionControlSuiteVersion3   3

#define kPSActionControlSuiteVersion2   2

---

Typedef Documentation

typedef void(* PIEventNotifier)(DescriptorEventID eventID, PIActionDescriptor descriptor, PIDialogRecordOptions options, void *data)

The prototype for a plug-in routine that receives action event notification.

See PSActionControlProcs::AddNotify.

Parameters:

eventID	Event that occurred.
descriptor	Copy of result descriptor.
options	Options passed from event.
data	Plug-in data.

typedef void(* PICommandNotifier)(uint32 commandID, OSErr result, DescriptorEventID eventID, PIActionDescriptor descriptor, PIDialogRecordOptions options, void *data)

The prototype for a plug-in routine that receives a command completion notification associated with a PostCommand call.

Parameters:

commandID	Command ID matching the ID that was returned from PostCommand
result	The result from executing the event.
eventID	Event that occurred.
descriptor	Copy of result descriptor.
options	Options passed from event.
data	Plug-in data.

typedef SPErr(* PISuspendProc)(void *data)

The prototype for a plug-in routine that plays actions that are not recorded to the Actions Palette.

See PSActionControlProcs::SuspendHistory.

Parameters:

data	Plug-in data.

Returns:

Non-zero error if failure.

typedef struct PSActionControlProcs PSActionControlProcs

The set of routines available in the Action Control Suite.