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

#include <PIActions.h>

Data Fields
SPAPI OSErr(*	Make )(PIActionReference *reference)
	Make a new reference.
SPAPI OSErr(*	Free )(PIActionReference ref)
	Free a reference.
SPAPI OSErr(*	GetForm )(PIActionReference ref, DescriptorFormID *value)
	Gets the form of this reference.
SPAPI OSErr(*	GetDesiredClass )(PIActionReference ref, DescriptorClassID *value)
	Gets the class for the reference.
SPAPI OSErr(*	PutName )(PIActionReference ref, DescriptorClassID desiredClass, const char *cstrValue)
	Puts a name into a reference (`formName`) along with the desired class for the reference.
SPAPI OSErr(*	PutIndex )(PIActionReference ref, DescriptorClassID desiredClass, uint32 value)
	Puts an index into a reference (`formIndex`) along with the desired class for the reference.
SPAPI OSErr(*	PutIdentifier )(PIActionReference ref, DescriptorClassID desiredClass, uint32 value)
	Puts an identifier into a reference (`formIdentifier`) along with the desired class for the reference.
SPAPI OSErr(*	PutOffset )(PIActionReference ref, DescriptorClassID desiredClass, int32 value)
	Puts an offset into a reference (`formOffset`) along with the desired class for the reference.
SPAPI OSErr(*	PutEnumerated )(PIActionReference ref, DescriptorClassID desiredClass, DescriptorEnumTypeID type, DescriptorEnumID value)
	Puts an enumeration type and enumeration ID (`formEnumerated`) into a reference along with the desired class for the reference.
SPAPI OSErr(*	PutProperty )(PIActionReference ref, DescriptorClassID desiredClass, DescriptorKeyID value)
	Puts a property into a reference (`formProperty`) along with the desired class for the reference.
SPAPI OSErr(*	PutClass )(PIActionReference ref, DescriptorClassID desiredClass)
	Puts a class into a reference.
SPAPI OSErr(*	GetNameLength )(PIActionReference ref, uint32 *stringLength)
	Gets the length of a name from a reference.
SPAPI OSErr(*	GetName )(PIActionReference ref, char *name, uint32 maxLength)
	Gets a name from a reference (`formName`).
SPAPI OSErr(*	GetIndex )(PIActionReference ref, uint32 *value)
	Gets an index from a reference (`formIndex`).
SPAPI OSErr(*	GetIdentifier )(PIActionReference ref, uint32 *value)
	Gets an identifier from a reference (`formIdentifier`).
SPAPI OSErr(*	GetOffset )(PIActionReference ref, int32 *value)
	Gets an offset from a reference (`formOffset`).
SPAPI OSErr(*	GetEnumerated )(PIActionReference ref, DescriptorEnumTypeID type, DescriptorEnumID enumValue)
	Gets an enumeration type and enumeration id from a reference (`formEnumerated`).
SPAPI OSErr(*	GetProperty )(PIActionReference ref, DescriptorKeyID *value)
	Gets a property from a reference (`formProperty`).
SPAPI OSErr(*	GetContainer )(PIActionReference ref, PIActionReference *value)
	Gets a reference contained in this reference.
SPAPI OSErr(*	PutNameZString )(PIActionReference ref, DescriptorClassID desiredClass, ASZString zstring)
	Puts a name into a reference (`formName`) along with the desired class for the reference using zstring.
SPAPI OSErr(*	GetNameZString )(PIActionReference ref, ASZString *zstring)
	Gets a name from a reference (`formName`) as a zstring.

Detailed Description

The set of routines available in the Action Reference Suite.

Field Documentation

SPAPI OSErr(* PSActionReferenceProcs::Make)(PIActionReference *reference)

Make a new reference.

Parameters:

reference [OUT] The new reference.

Returns:: Non-zero error if unable to allocate the memory.

SPAPI OSErr(* PSActionReferenceProcs::Free)(PIActionReference ref)

Free a reference.

Parameters:

ref	The reference to free the memory for.

Returns:: Non-zero error if failure.

SPAPI OSErr(* PSActionReferenceProcs::GetForm)(PIActionReference ref, DescriptorFormID *value)

Gets the form of this reference.

Generally, when retrieving information from a reference, the code uses GetForm, and uses the returned form to determine which of the other Get routines to use. The form identifiers are provided with each of the Get and Put routines.

Parameters:

ref	The reference to read from.
value	[OUT] The form for the reference, returned.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetDesiredClass)(PIActionReference ref, DescriptorClassID *value)

Gets the class for the reference.

Parameters:

ref	The reference to read from.
value	[OUT] The class ID returned. See PITerminology.h for predefined class.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::PutName)(PIActionReference ref, DescriptorClassID desiredClass, const char *cstrValue)

Puts a name into a reference (formName) along with the desired class for the reference.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.
cstrValue	The name to write.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::PutIndex)(PIActionReference ref, DescriptorClassID desiredClass, uint32 value)

Puts an index into a reference (formIndex) along with the desired class for the reference.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.
value	The index to write.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::PutIdentifier)(PIActionReference ref, DescriptorClassID desiredClass, uint32 value)

Puts an identifier into a reference (formIdentifier) along with the desired class for the reference.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.
value	The identifier to write.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::PutOffset)(PIActionReference ref, DescriptorClassID desiredClass, int32 value)

Puts an offset into a reference (formOffset) along with the desired class for the reference.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.
value	The offset to write.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::PutEnumerated)(PIActionReference ref, DescriptorClassID desiredClass, DescriptorEnumTypeID type, DescriptorEnumID value)

Puts an enumeration type and enumeration ID (formEnumerated) into a reference along with the desired class for the reference.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.
type	The enumeration type to write.
value	The enumeration ID to write.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::PutProperty)(PIActionReference ref, DescriptorClassID desiredClass, DescriptorKeyID value)

Puts a property into a reference (formProperty) along with the desired class for the reference.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.
value	The property key to write.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::PutClass)(PIActionReference ref, DescriptorClassID desiredClass)

Puts a class into a reference.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetNameLength)(PIActionReference ref, uint32 *stringLength)

Gets the length of a name from a reference.

See GetName for an example.

Parameters:

ref	The reference from which to read.
strLength	[OUT] The length of the name, returned.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetName)(PIActionReference ref, char *name, uint32 maxLength)

Gets a name from a reference (formName).

Parameters:

ref	The reference from which to read.
name	[OUT] The name, returned.
maxLength	The maximum number of characters to read.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetIndex)(PIActionReference ref, uint32 *value)

Gets an index from a reference (formIndex).

Parameters:

ref	The reference from which to read.
value	[OUT] The index, returned.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetIdentifier)(PIActionReference ref, uint32 *value)

Gets an identifier from a reference (formIdentifier).

Parameters:

ref	The reference from which to read.
value	[OUT] The identifier, returned.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetOffset)(PIActionReference ref, int32 *value)

Gets an offset from a reference (formOffset).

Parameters:

ref	The reference from which to read.
value	[OUT] The offset, returned.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetEnumerated)(PIActionReference ref, DescriptorEnumTypeID *type, DescriptorEnumID *enumValue)

Gets an enumeration type and enumeration id from a reference (formEnumerated).

Parameters:

ref	The reference from which to read.
type	[OUT] The enumeration type, returned.
enumValue	[OUT] The enumeration ID, returned.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetProperty)(PIActionReference ref, DescriptorKeyID *value)

Gets a property from a reference (formProperty).

Parameters:

ref	The reference from which to read.
value	[OUT] The property key, returned.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetContainer)(PIActionReference ref, PIActionReference *value)

Gets a reference contained in this reference.

Container references provide additional pieces to the reference. This looks like another reference but is actually part of the same reference.

Parameters:

ref	The reference to get the container for.
value	[OUT] A reference contained in `ref`. Is NULL if no container.

Returns:: Non-zero error on failure.

SPAPI OSErr(* PSActionReferenceProcs::PutNameZString)(PIActionReference ref, DescriptorClassID desiredClass, ASZString zstring)

Puts a name into a reference (formName) along with the desired class for the reference using zstring.

Parameters:

ref	The reference in which to write.
desiredClass	The class for the reference.
zstring	The name to write.

Returns:: Non-zero error in failure.

SPAPI OSErr(* PSActionReferenceProcs::GetNameZString)(PIActionReference ref, ASZString *zstring)

Gets a name from a reference (formName) as a zstring.

Parameters:

ref	The reference from which to read.
zstring	[OUT] The name, returned.
maxLength	The maximum number of characters to read.

Returns:: Non-zero error in failure.

The documentation for this struct was generated from the following file:

PIActions.h

Getting Started

SDK API Reference

SDK API Features

Other Documentation

Data Fields

Detailed Description

Field Documentation