Getting Started

SDK API Reference

SDK API Features

Other Documentation
Data Fields
PSActionDescriptorProcs3 Struct Reference

The set of routines available in the Action Descriptor Suite. More...

#include <PIActions.h>

Data Fields

SPAPI OSErr(* Make )(PIActionDescriptor *descriptor)
SPAPI OSErr(* Free )(PIActionDescriptor descriptor)
SPAPI OSErr(* GetType )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorTypeID *type)
SPAPI OSErr(* GetKey )(PIActionDescriptor descriptor, uint32 index, DescriptorKeyID *key)
SPAPI OSErr(* HasKey )(PIActionDescriptor descriptor, DescriptorKeyID key, Boolean *hasKey)
SPAPI OSErr(* GetCount )(PIActionDescriptor descriptor, uint32 *count)
SPAPI OSErr(* IsEqual )(PIActionDescriptor descriptor, PIActionDescriptor other, Boolean *isEqual)
SPAPI OSErr(* Erase )(PIActionDescriptor descriptor, DescriptorKeyID)
SPAPI OSErr(* Clear )(PIActionDescriptor descriptor)
SPAPI OSErr(* PutInteger )(PIActionDescriptor descriptor, DescriptorKeyID key, int32 value)
SPAPI OSErr(* PutFloat )(PIActionDescriptor descriptor, DescriptorKeyID key, real64 value)
SPAPI OSErr(* PutUnitFloat )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorUnitID unit, real64 value)
SPAPI OSErr(* PutString )(PIActionDescriptor descriptor, DescriptorKeyID key, const char *cstrValue)
SPAPI OSErr(* PutBoolean )(PIActionDescriptor descriptor, DescriptorKeyID key, Boolean value)
SPAPI OSErr(* PutList )(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionList value)
SPAPI OSErr(* PutObject )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID type, PIActionDescriptor value)
SPAPI OSErr(* PutGlobalObject )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID type, PIActionDescriptor value)
SPAPI OSErr(* PutEnumerated )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorEnumTypeID type, DescriptorEnumID value)
SPAPI OSErr(* PutReference )(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionReference value)
SPAPI OSErr(* PutClass )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID value)
SPAPI OSErr(* PutGlobalClass )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID value)
SPAPI OSErr(* PutAlias )(PIActionDescriptor descriptor, DescriptorKeyID key, Handle value)
SPAPI OSErr(* GetInteger )(PIActionDescriptor descriptor, DescriptorKeyID key, int32 *value)
SPAPI OSErr(* GetFloat )(PIActionDescriptor descriptor, DescriptorKeyID key, real64 *value)
SPAPI OSErr(* GetUnitFloat )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorUnitID *unit, real64 *value)
SPAPI OSErr(* GetStringLength )(PIActionDescriptor descriptor, DescriptorKeyID key, uint32 *stringLength)
SPAPI OSErr(* GetString )(PIActionDescriptor descriptor, DescriptorKeyID key, char *cstrValue, uint32 maxLength)
SPAPI OSErr(* GetBoolean )(PIActionDescriptor descriptor, DescriptorKeyID key, Boolean *value)
SPAPI OSErr(* GetList )(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionList *value)
SPAPI OSErr(* GetObject )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *type, PIActionDescriptor *value)
SPAPI OSErr(* GetGlobalObject )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *type, PIActionDescriptor *value)
SPAPI OSErr(* GetEnumerated )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorEnumTypeID *type, DescriptorEnumID *value)
SPAPI OSErr(* GetReference )(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionReference *value)
SPAPI OSErr(* GetClass )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *value)
SPAPI OSErr(* GetGlobalClass )(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *value)
SPAPI OSErr(* GetAlias )(PIActionDescriptor descriptor, DescriptorKeyID key, Handle *value)
SPAPI OSErr(* HasKeys )(PIActionDescriptor descriptor, DescriptorKeyIDArray requiredKeys, Boolean *hasKeys)
SPAPI OSErr(* PutIntegers )(PIActionDescriptor descriptor, DescriptorKeyID key, uint32 count, int32 *)
SPAPI OSErr(* GetIntegers )(PIActionDescriptor descriptor, DescriptorKeyID key, uint32 count, int32 *value)
SPAPI OSErr(* AsHandle )(PIActionDescriptor descriptor, PIDescriptorHandle *value)
SPAPI OSErr(* HandleToDescriptor )(PIDescriptorHandle value, PIActionDescriptor *descriptor)
SPAPI OSErr(* PutZString )(PIActionDescriptor descriptor, DescriptorKeyID key, ASZString zstring)
SPAPI OSErr(* GetZString )(PIActionDescriptor descriptor, DescriptorKeyID key, ASZString *zstring)
SPAPI OSErr(* PutData )(PIActionDescriptor descriptor, DescriptorKeyID key, int32 length, void *value)
SPAPI OSErr(* GetDataLength )(PIActionDescriptor descriptor, DescriptorKeyID key, int32 *value)
SPAPI OSErr(* GetData )(PIActionDescriptor descriptor, DescriptorKeyID key, void *value)
SPAPI OSErr(* PutInteger64 )(PIActionDescriptor descriptor, DescriptorKeyID key, int64 value)
SPAPI OSErr(* GetInteger64 )(PIActionDescriptor descriptor, DescriptorKeyID key, int64 *value)

Detailed Description

The set of routines available in the Action Descriptor Suite.

Version 3. See above for documentation.

Field Documentation

SPAPI OSErr(* PSActionDescriptorProcs3::Make)(PIActionDescriptor *descriptor)
SPAPI OSErr(* PSActionDescriptorProcs3::Free)(PIActionDescriptor descriptor)
SPAPI OSErr(* PSActionDescriptorProcs3::GetType)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorTypeID *type)
SPAPI OSErr(* PSActionDescriptorProcs3::GetKey)(PIActionDescriptor descriptor, uint32 index, DescriptorKeyID *key)
SPAPI OSErr(* PSActionDescriptorProcs3::HasKey)(PIActionDescriptor descriptor, DescriptorKeyID key, Boolean *hasKey)
SPAPI OSErr(* PSActionDescriptorProcs3::GetCount)(PIActionDescriptor descriptor, uint32 *count)
SPAPI OSErr(* PSActionDescriptorProcs3::IsEqual)(PIActionDescriptor descriptor, PIActionDescriptor other, Boolean *isEqual)
SPAPI OSErr(* PSActionDescriptorProcs3::Erase)(PIActionDescriptor descriptor, DescriptorKeyID)
SPAPI OSErr(* PSActionDescriptorProcs3::Clear)(PIActionDescriptor descriptor)
SPAPI OSErr(* PSActionDescriptorProcs3::PutInteger)(PIActionDescriptor descriptor, DescriptorKeyID key, int32 value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutFloat)(PIActionDescriptor descriptor, DescriptorKeyID key, real64 value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutUnitFloat)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorUnitID unit, real64 value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutString)(PIActionDescriptor descriptor, DescriptorKeyID key, const char *cstrValue)
SPAPI OSErr(* PSActionDescriptorProcs3::PutBoolean)(PIActionDescriptor descriptor, DescriptorKeyID key, Boolean value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutList)(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionList value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutObject)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID type, PIActionDescriptor value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutGlobalObject)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID type, PIActionDescriptor value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutEnumerated)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorEnumTypeID type, DescriptorEnumID value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutReference)(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionReference value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutClass)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutGlobalClass)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutAlias)(PIActionDescriptor descriptor, DescriptorKeyID key, Handle value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetInteger)(PIActionDescriptor descriptor, DescriptorKeyID key, int32 *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetFloat)(PIActionDescriptor descriptor, DescriptorKeyID key, real64 *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetUnitFloat)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorUnitID *unit, real64 *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetStringLength)(PIActionDescriptor descriptor, DescriptorKeyID key, uint32 *stringLength)
SPAPI OSErr(* PSActionDescriptorProcs3::GetString)(PIActionDescriptor descriptor, DescriptorKeyID key, char *cstrValue, uint32 maxLength)
SPAPI OSErr(* PSActionDescriptorProcs3::GetBoolean)(PIActionDescriptor descriptor, DescriptorKeyID key, Boolean *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetList)(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionList *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetObject)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *type, PIActionDescriptor *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetGlobalObject)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *type, PIActionDescriptor *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetEnumerated)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorEnumTypeID *type, DescriptorEnumID *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetReference)(PIActionDescriptor descriptor, DescriptorKeyID key, PIActionReference *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetClass)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetGlobalClass)(PIActionDescriptor descriptor, DescriptorKeyID key, DescriptorClassID *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetAlias)(PIActionDescriptor descriptor, DescriptorKeyID key, Handle *value)
SPAPI OSErr(* PSActionDescriptorProcs3::HasKeys)(PIActionDescriptor descriptor, DescriptorKeyIDArray requiredKeys, Boolean *hasKeys)
SPAPI OSErr(* PSActionDescriptorProcs3::PutIntegers)(PIActionDescriptor descriptor, DescriptorKeyID key, uint32 count, int32 *)
SPAPI OSErr(* PSActionDescriptorProcs3::GetIntegers)(PIActionDescriptor descriptor, DescriptorKeyID key, uint32 count, int32 *value)
SPAPI OSErr(* PSActionDescriptorProcs3::AsHandle)(PIActionDescriptor descriptor, PIDescriptorHandle *value)
SPAPI OSErr(* PSActionDescriptorProcs3::HandleToDescriptor)(PIDescriptorHandle value, PIActionDescriptor *descriptor)
SPAPI OSErr(* PSActionDescriptorProcs3::PutZString)(PIActionDescriptor descriptor, DescriptorKeyID key, ASZString zstring)
SPAPI OSErr(* PSActionDescriptorProcs3::GetZString)(PIActionDescriptor descriptor, DescriptorKeyID key, ASZString *zstring)
SPAPI OSErr(* PSActionDescriptorProcs3::PutData)(PIActionDescriptor descriptor, DescriptorKeyID key, int32 length, void *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetDataLength)(PIActionDescriptor descriptor, DescriptorKeyID key, int32 *value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetData)(PIActionDescriptor descriptor, DescriptorKeyID key, void *value)
SPAPI OSErr(* PSActionDescriptorProcs3::PutInteger64)(PIActionDescriptor descriptor, DescriptorKeyID key, int64 value)
SPAPI OSErr(* PSActionDescriptorProcs3::GetInteger64)(PIActionDescriptor descriptor, DescriptorKeyID key, int64 *value)
The documentation for this struct was generated from the following file: