PSActionListProcs Struct Reference

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

#include <PIActions.h>

Data Fields
SPAPI OSErr(*	Make )(PIActionList *actionList)
	Make a new list.
SPAPI OSErr(*	Free )(PIActionList actionList)
	Free a list.
SPAPI OSErr(*	GetType )(PIActionList list, uint32 index, DescriptorTypeID *value)
	Gets the type for an index within a list.
SPAPI OSErr(*	GetCount )(PIActionList list, uint32 *value)
	Returns the number of items in the list.
SPAPI OSErr(*	PutInteger )(PIActionList list, int32 value)
	Puts an integer value (typeInteger) into a list.
SPAPI OSErr(*	PutFloat )(PIActionList list, real64 value)
	Puts a floating point number (typeFloat) into a list.
SPAPI OSErr(*	PutUnitFloat )(PIActionList list, DescriptorUnitID unit, real64 value)
	Puts a unit floating point number (typeUnitFloat) into a list.
SPAPI OSErr(*	PutString )(PIActionList list, const char *cstr)
	Puts a string (typeChar) into a list.
SPAPI OSErr(*	PutBoolean )(PIActionList list, Boolean value)
	Puts a boolean value (typeBoolean) into a list.
SPAPI OSErr(*	PutList )(PIActionList list, PIActionList value)
	Puts a list (typeValueList) into a list.
SPAPI OSErr(*	PutObject )(PIActionList list, DescriptorClassID type, PIActionDescriptor value)
	Puts an object (typeObject) of a specified type into a list.
SPAPI OSErr(*	PutGlobalObject )(PIActionList list, DescriptorClassID type, PIActionDescriptor value)
	Puts a global object (typeGlobalObject) of a specified type into a list.
SPAPI OSErr(*	PutEnumerated )(PIActionList list, DescriptorEnumTypeID type, DescriptorEnumID value)
	Puts an enumeration id for a specified enumeration (typeEnumerated) into a list.
SPAPI OSErr(*	PutReference )(PIActionList list, PIActionReference value)
	Puts a reference (typeObjectReference, typeObjectSpecifier) into a list.
SPAPI OSErr(*	PutClass )(PIActionList list, DescriptorClassID value)
	Puts a class (typeClass) into a list.
SPAPI OSErr(*	PutGlobalClass )(PIActionList list, DescriptorClassID value)
	Puts a global class (typeGlobalClass) into a list.
SPAPI OSErr(*	PutAlias )(PIActionList list, Handle value)
	Puts an alias (typeAlias) into a list.
SPAPI OSErr(*	GetInteger )(PIActionList list, uint32 index, int32 *value)
	Gets an integer value (typeInteger) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetFloat )(PIActionList list, uint32 index, real64 *value)
	Gets a floating point number (typeFloat) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetUnitFloat )(PIActionList list, uint32 index, DescriptorUnitID *unit, real64 *value)
	Gets a unit floating point number (typeUnitFloat) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetStringLength )(PIActionList list, uint32 index, uint32 *stringLength)
	Gets a string length from a list, given an indexed position in the list.
SPAPI OSErr(*	GetString )(PIActionList list, uint32 index, char *cstr, uint32 maxLength)
	Gets a string (typeChar) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetBoolean )(PIActionList list, uint32 index, Boolean *value)
	Gets a boolean value (typeBoolean) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetList )(PIActionList list, uint32 index, PIActionList *actionList)
	Gets a list (typeValueList) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetObject )(PIActionList list, uint32 index, DescriptorClassID *type, PIActionDescriptor *value)
	Gets an object (typeObject) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetGlobalObject )(PIActionList list, uint32 index, DescriptorClassID *type, PIActionDescriptor *value)
	Gets a global object (typeGlobalObject) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetEnumerated )(PIActionList list, uint32 index, DescriptorEnumTypeID *type, DescriptorEnumID *value)
	Gets an enumeration id and an enumeration type (typeEnumerated) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetReference )(PIActionList list, uint32 index, PIActionReference *value)
	Gets a basic reference (typeObjectReference) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetClass )(PIActionList list, uint32 index, DescriptorClassID *value)
	Gets a class (typeClass) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetGlobalClass )(PIActionList list, uint32 index, DescriptorClassID *value)
	Gets a global class (typeGlobalClass) from a list, given an indexed position in the list.
SPAPI OSErr(*	GetAlias )(PIActionList list, uint32 index, Handle *aliasHandle)
	Gets an alias (typeAlias) from a list, given an indexed position in the list.
SPAPI OSErr(*	PutIntegers )(PIActionList list, uint32 count, int32 *)
	Puts count values from an integer array into a list.
SPAPI OSErr(*	GetIntegers )(PIActionList list, uint32 count, int32 *value)
	Gets count values into integer array value from a list.
SPAPI OSErr(*	PutData )(PIActionList list, int32 length, void *data)
	Puts a data block (typeRawData) into a list.
SPAPI OSErr(*	GetDataLength )(PIActionList list, uint32 index, int32 *length)
	Gets the length of a data block from a list for a given index.
SPAPI OSErr(*	GetData )(PIActionList list, uint32 index, void *value)
	Gets a data block (typeRawData) from a list for a given index.
SPAPI OSErr(*	PutZString )(PIActionList list, ASZString zstring)
	Puts a zstring (typeChar) into a list.
SPAPI OSErr(*	GetZString )(PIActionList list, uint32 index, ASZString *zstring)
	Gets a zstring (typeChar) from a list for a given index.
SPAPI OSErr(*	PutInteger64 )(PIActionList list, int64 value)
	Puts a 64 bit integer value (typeComp (typeSInt64)) into a list.
SPAPI OSErr(*	GetInteger64 )(PIActionList list, uint32 index, int64 *value)
	Gets a 64 bit integer value (typeComp (typeSInt64)) from a list, given an indexed position in the list.
SPAPI OSErr(*	PutBookmark )(PIActionList list, CFDataRef value)
	Converts a bookmark to an alias and puts that alias (typeAlias) into a list.
SPAPI OSErr(*	GetBookmark )(PIActionList list, uint32 index, CFDataRef *bookmark)
	Gets an alias (typeAlias) from a list, given an indexed position in the list, converts to a bookmark, and returns it Will switch to typeBookmark when Photoshop quits using the Alias Manager for aliases and switches to bookmarks.

---

Detailed Description

The set of available routines for the Action List Suite.

---

Field Documentation

SPAPI OSErr(* PSActionListProcs::Make)(PIActionList *actionList)

Make a new list.

Parameters:

actionList

[OUT] The new list.

Returns:

Non-zero error if unable to allocate the memory.

SPAPI OSErr(* PSActionListProcs::Free)(PIActionList actionList)

Free a list.

Parameters:

actionList

The list to free the memory for.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetType)(PIActionList list, uint32 index, DescriptorTypeID *value)

Gets the type for an index within a list.

Often used with GetCount to iterate through a list, getting the type of each item in a list, and then using the index and type to retrieve the value. See the individual Get and Put routines for the types associated with each.

Parameters:

list	List to get the type of.
index	Index to get the type of.
value	[OUT] Type for the value stored at index. and the Get and Put routines for possible values.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetCount)(PIActionList list, uint32 *value)

Returns the number of items in the list.

See GetType for an example.

Parameters:

list	The list from which to get the count.
value	[OUT] The number of items in the list.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::PutInteger)(PIActionList list, int32 value)

Puts an integer value (typeInteger) into a list.

Parameters:

list	The list in which to write.
value	The integer value to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutFloat)(PIActionList list, real64 value)

Puts a floating point number (typeFloat) into a list.

Parameters:

list	The list in which to write.
value	The floating point number to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutUnitFloat)(PIActionList list, DescriptorUnitID unit, real64 value)

Puts a unit floating point number (typeUnitFloat) into a list.

Parameters:

list	The list in which to write.
unit	The unit to write.
value	The floating point number to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutString)(PIActionList list, const char *cstr)

Puts a string (typeChar) into a list.

Parameters:

list	The list in which to write.
cstr	The string to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutBoolean)(PIActionList list, Boolean value)

Puts a boolean value (typeBoolean) into a list.

Parameters:

list	The list in which to write.
value	The boolean to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutList)(PIActionList list, PIActionList value)

Puts a list (typeValueList) into a list.

Parameters:

list	The list in which to write.
value	The list to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutObject)(PIActionList list, DescriptorClassID type, PIActionDescriptor value)

Puts an object (typeObject) of a specified type into a list.

Note:

Using GetType on an index that contains an object returns typeObject, rather than the type stored with the object. This allows the code to easily determine which Get routine to use to retrieve the object. The actual type of the object is retrieved with GetObject.

Parameters:

list	The list in which to write.
type	The type of object to insert.
value	The object to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutGlobalObject)(PIActionList list, DescriptorClassID type, PIActionDescriptor value)

Puts a global object (typeGlobalObject) of a specified type into a list.

Note:

Using GetType on an index that contains a global object returns typeGlobalObject, rather than the type stored with the object. This allows the code to easily determine which Get routine to use to retrieve the object. The actual type of the object is retrieved with GetGlobalObject.

Parameters:

list	The list in which to write.
type	The type of object to insert.
value	The object to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutEnumerated)(PIActionList list, DescriptorEnumTypeID type, DescriptorEnumID value)

Puts an enumeration id for a specified enumeration (typeEnumerated) into a list.

Parameters:

list	The list in which to write.
type	The type of enumeration.
value	The enumeration id to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutReference)(PIActionList list, PIActionReference value)

Puts a reference (typeObjectReference, typeObjectSpecifier) into a list.

Parameters:

list	The list in which to write.
value	The reference to insert. See Action Reference Suite.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutClass)(PIActionList list, DescriptorClassID value)

Puts a class (typeClass) into a list.

Parameters:

list	The list in which to write.
value	The class to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutGlobalClass)(PIActionList list, DescriptorClassID value)

Puts a global class (typeGlobalClass) into a list.

Parameters:

list	The list in which to write.
value	The class to insert.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::PutAlias)(PIActionList list, Handle value)

Puts an alias (typeAlias) into a list.

Parameters:

descriptor	The list in which to write.
value	The alias to insert.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetInteger)(PIActionList list, uint32 index, int32 *value)

Gets an integer value (typeInteger) from a list, given an indexed position in the list.

Typically, code iterates through the indices in a list, first getting the type of the item, and using the type to select the appropriate Get routine. See GetType for an example.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The integer value returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetFloat)(PIActionList list, uint32 index, real64 *value)

Gets a floating point number (typeFloat) from a list, given an indexed position in the list.

Typically, code iterates through the indices in a list, first getting the type of the item, and using the type to select the appropriate Get routine. See GetType for an example.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The floating point number returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetUnitFloat)(PIActionList list, uint32 index, DescriptorUnitID *unit, real64 *value)

Gets a unit floating point number (typeUnitFloat) from a list, given an indexed position in the list.

Typically, code iterates through the indices in a list, first getting the type of the item, and using the type to select the appropriate Get routine. See GetType for an example.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
unit	[OUT] The unit returned.
value	[OUT] The floating point number returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetStringLength)(PIActionList list, uint32 index, uint32 *stringLength)

Gets a string length from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
stringLength	[OUT] The length of the string at the indexed position.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetString)(PIActionList list, uint32 index, char *cstr, uint32 maxLength)

Gets a string (typeChar) from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
cstr	[OUT] The length of the string at the indexed position.
maxLength	The maximum number of characters to return.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetBoolean)(PIActionList list, uint32 index, Boolean *value)

Gets a boolean value (typeBoolean) from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The boolean value returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetList)(PIActionList list, uint32 index, PIActionList *actionList)

Gets a list (typeValueList) from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The list returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetObject)(PIActionList list, uint32 index, DescriptorClassID *type, PIActionDescriptor *value)

Gets an object (typeObject) from a list, given an indexed position in the list.

Note:

Using GetType on an index that contains an object returns typeObject, rather than the type stored with the object. This allows the code to easily determine which Get routine to use to retrieve the object.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
type	[OUT] The type of the object returned.
value	[OUT] The list returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetGlobalObject)(PIActionList list, uint32 index, DescriptorClassID *type, PIActionDescriptor *value)

Gets a global object (typeGlobalObject) from a list, given an indexed position in the list.

Note:

Using GetType on an index that contains a global object returns typeGlobalObject, rather than the type stored with the object. This allows the code to easily determine which Get routine to use to retrieve the object.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
type	[OUT] The type of the object returned.
value	[OUT] The list returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetEnumerated)(PIActionList list, uint32 index, DescriptorEnumTypeID *type, DescriptorEnumID *value)

Gets an enumeration id and an enumeration type (typeEnumerated) from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
type	[OUT] The type of enumeration, returned.
value	[OUT] The enumeration id, returned.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::GetReference)(PIActionList list, uint32 index, PIActionReference *value)

Gets a basic reference (typeObjectReference) from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The object reference returned. See Action Reference Suite.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetClass)(PIActionList list, uint32 index, DescriptorClassID *value)

Gets a class (typeClass) from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The class returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetGlobalClass)(PIActionList list, uint32 index, DescriptorClassID *value)

Gets a global class (typeGlobalClass) from a list, given an indexed position in the list.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The global class returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetAlias)(PIActionList list, uint32 index, Handle *aliasHandle)

Gets an alias (typeAlias) from a list, given an indexed position in the list.

Use DisposeRegularHandle from the Handle suite to dispose of the handle.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
aliasHandle	[OUT] The alias returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::PutIntegers)(PIActionList list, uint32 count, int32 *)

Puts count values from an integer array into a list.

Parameters:

list	The list in which to write.
count	The number of integers to write.
int32	Array containing the integer values to write.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetIntegers)(PIActionList list, uint32 count, int32 *value)

Gets count values into integer array value from a list.

Parameters:

list	The list in which to write.
count	The number of integers to return.
value	[OUT] Array of integer values returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::PutData)(PIActionList list, int32 length, void *data)

Puts a data block (typeRawData) into a list.

Parameters:

list	The list in which to write.
length	The length of the data block.
data	The data block to write.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::GetDataLength)(PIActionList list, uint32 index, int32 *length)

Gets the length of a data block from a list for a given index.

Parameters:

list	The list from which to read.
index	The index for which to return the data block length.
value	[OUT] The length of the data block.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::GetData)(PIActionList list, uint32 index, void *value)

Gets a data block (typeRawData) from a list for a given index.

Parameters:

list	The list from which to read.
index	The index for which to return the data block.
value	[OUT] The data block returned.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutZString)(PIActionList list, ASZString zstring)

Puts a zstring (typeChar) into a list.

Parameters:

list	The list in which to write.
zstring	The zstring to write.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::GetZString)(PIActionList list, uint32 index, ASZString *zstring)

Gets a zstring (typeChar) from a list for a given index.

Parameters:

list	The list from which to read.
index	The index for which to return the string.
zstring	[OUT] The zstring returned.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::PutInteger64)(PIActionList list, int64 value)

Puts a 64 bit integer value (typeComp (typeSInt64)) into a list.

Parameters:

list	The list in which to write.
value	The 64 bit integer value to insert.

Returns:

Non-zero error if failure

SPAPI OSErr(* PSActionListProcs::GetInteger64)(PIActionList list, uint32 index, int64 *value)

Gets a 64 bit integer value (typeComp (typeSInt64)) from a list, given an indexed position in the list.

Typically, code iterates through the indices in a list, first getting the type of the item, and using the type to select the appropriate Get routine. See GetType for an example.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
value	[OUT] The 64 bit integer value returned.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::PutBookmark)(PIActionList list, CFDataRef value)

Converts a bookmark to an alias and puts that alias (typeAlias) into a list.

Will switch to typeBookmark when Photoshop quits using the Alias Manager for aliases and switches to bookmarks

Parameters:

descriptor	The list in which to write.
value	The bookmark to insert.

Returns:

Non-zero error if failure.

SPAPI OSErr(* PSActionListProcs::GetBookmark)(PIActionList list, uint32 index, CFDataRef *bookmark)

Gets an alias (typeAlias) from a list, given an indexed position in the list, converts to a bookmark, and returns it Will switch to typeBookmark when Photoshop quits using the Alias Manager for aliases and switches to bookmarks.

Parameters:

list	The list from which to read.
index	Indexed position in the list to retrieve.
bookmark	[OUT] The bookmark returned. Caller must call CFRelease on the bookmark. The bookmark will be NULL if the alias points to something which is not currently accessible.

Returns:

Non-zero error if failure.

---

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

• PIActions.h