AIEntrySuite Struct Reference
[API Suite List]

This suite provides functions for constructing and inspecting dictionary and array entries. More...

#include <AIEntry.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	AddRef )(AIEntryRef entry)
	Reference count maintenance.
AIAPI ai::int32(*	Release )(AIEntryRef entry)
	Reference count maintenance.
AIAPI AIEntryType(*	GetType )(AIEntryRef entry)
	Retrieves the type of an entry.
AIAPI AIErr(*	ToBoolean )(AIEntryRef entry, ASBoolean *value)
	Retrieves the boolean value of an entry.
AIAPI AIEntryRef(*	FromBoolean )(ASBoolean value)
	Constructs an entry from a boolean value.
AIAPI AIErr(*	ToInteger )(AIEntryRef entry, ai::int32 *value)
	Retrieves the integer value of an entry.
AIAPI AIEntryRef(*	FromInteger )(ai::int32 value)
	Constructs an entry from an integer value.
AIAPI AIErr(*	ToReal )(AIEntryRef entry, AIReal *value)
	Retrieves the real-number value of an entry.
AIAPI AIEntryRef(*	FromReal )(AIReal value)
	Constructs an entry from a real-number value.
AIAPI AIErr(*	ToRealPoint )(AIEntryRef entry, AIRealPoint *value)
	Retrieves the point value of an entry.
AIAPI AIEntryRef(*	FromRealPoint )(const AIRealPoint *value)
	Constructs an entry from a point value.
AIAPI AIErr(*	ToRealMatrix )(AIEntryRef entry, AIRealMatrix *value)
	Retrieves the transformation-matrix value of an entry.
AIAPI AIEntryRef(*	FromRealMatrix )(const AIRealMatrix *value)
	Constructs an entry from a transformation-matrix value.
AIAPI AIErr(*	ToString )(AIEntryRef entry, const char **value)
	Retrieves the string value of an entry.
AIAPI AIEntryRef(*	FromString )(const char *value)
	Constructs an entry from a string value.
AIAPI AIErr(*	ToDict )(AIEntryRef entry, AIDictionaryRef *value)
	Retrieves the dictionary value of an entry.
AIAPI AIEntryRef(*	FromDict )(AIDictionaryRef value)
	Constructs an entry from a dictionary value.
AIAPI AIErr(*	ToArt )(AIEntryRef entry, AIArtHandle *art)
	Retrieves the art object value of an entry.
AIAPI AIErr(*	ToArray )(AIEntryRef entry, AIArrayRef *value)
	Retrieves the array value of an entry.
AIAPI AIEntryRef(*	FromArray )(AIArrayRef value)
	Constructs an entry from an array value.
AIAPI AIErr(*	ToBinary )(AIEntryRef entry, void *value, size_t *size)
	Retrieves the binary data value of an entry.
AIAPI AIEntryRef(*	FromBinary )(void *value, size_t size)
	Constructs an entry from a binary data value.
AIAPI AIErr(*	ToPattern )(AIEntryRef entry, AIPatternHandle *value)
	Retrieves the pattern object value of an entry.
AIAPI AIEntryRef(*	FromPattern )(AIPatternHandle value)
	Constructs an entry from a pattern object value.
AIAPI AIErr(*	ToBrushPattern )(AIEntryRef entry, AIPatternHandle *value)
	Retrieves the brush pattern object value of an entry.
AIAPI AIEntryRef(*	FromBrushPattern )(AIPatternHandle value)
	Constructs an entry from a brush pattern object value.
AIAPI AIErr(*	ToGradient )(AIEntryRef entry, AIGradientHandle *value)
	Retrieves the gradient object value of an entry.
AIAPI AIEntryRef(*	FromGradient )(AIGradientHandle value)
	Constructs an entry from a gradient object value.
AIAPI AIErr(*	ToCustomColor )(AIEntryRef entry, AICustomColorHandle *value)
	Retrieves the custom color object value of an entry.
AIAPI AIEntryRef(*	FromCustomColor )(AICustomColorHandle value)
	Constructs an entry from a custom color object value.
AIAPI AIErr(*	ToPluginObject )(AIEntryRef entry, AIObjectHandle *value)
	Retrieves the plug-in global object value of an entry.
AIAPI AIEntryRef(*	FromPluginObject )(AIObjectHandle value)
	Constructs an entry from a plug-in global object value.
AIAPI AIErr(*	ToFillStyle )(AIEntryRef entry, struct AIFillStyle *value)
	Retrieves the fill style value of an entry.
AIAPI AIEntryRef(*	FromFillStyle )(const struct AIFillStyle *value)
	Constructs an entry from a fill style value.
AIAPI AIErr(*	ToStrokeStyle )(AIEntryRef entry, struct AIStrokeStyle *value)
	Retrieves the stroke style value of an entry.
AIAPI AIEntryRef(*	FromStrokeStyle )(const struct AIStrokeStyle *value)
	Constructs an entry from a stroke style value.
AIAPI AIErr(*	ToUID )(AIEntryRef entry, AIUIDRef *value)
	Retrieves the unique identifier value of an entry.
AIAPI AIEntryRef(*	FromUID )(AIUIDRef value)
	Constructs an entry from a unique identifier value.
AIAPI AIErr(*	ToUIDREF )(AIEntryRef entry, AIUIDREFRef *value)
	Retrieves the unique identifier reference value of an entry.
AIAPI AIEntryRef(*	FromUIDREF )(AIUIDREFRef value)
	Constructs an entry from a unique identifier reference value.
AIAPI AIErr(*	ToXMLNode )(AIEntryRef entry, AIXMLNodeRef *value)
	Retrieves the XML node value of an entry.
AIAPI AIEntryRef(*	FromXMLNode )(AIXMLNodeRef value)
	Constructs an entry from an XML node value.
AIAPI AIErr(*	ToSVGFilterHandle )(AIEntryRef entry, AISVGFilterHandle *value)
	Retrieves the SVG filter value of an entry.
AIAPI AIEntryRef(*	FromSVGFilterHandle )(AISVGFilterHandle value)
	Constructs an entry from an SVG filter value.
AIAPI AIErr(*	ToSymbolPattern )(AIEntryRef entry, AIPatternHandle *value)
	Retrieves the symbol pattern object value of an entry.
AIAPI AIEntryRef(*	FromSymbolPattern )(AIPatternHandle value)
	Constructs an entry from a symbol pattern object value.
AIAPI AIErr(*	AsBoolean )(AIEntryRef entry, ASBoolean *value)
	Retrieves a string entry as a boolean if possible.
AIAPI AIErr(*	AsInteger )(AIEntryRef entry, ai::int32 *value)
	Retrieves a string entry as an integer if possible.
AIAPI AIErr(*	AsReal )(AIEntryRef entry, AIReal *value)
	Retrieves a string entry as a real number if possible.
AIAPI AIErr(*	AsString )(AIEntryRef entry, const char **value)
	Retrieves an entry as a string if possible.
AIAPI AIErr(*	AsUIDREF )(AIEntryRef entry, AIUIDREFRef *value)
	Retrieves a string entry as a unique identifier if possible.
AIAPI AIErr(*	ToArtStyle )(AIEntryRef entry, AIArtStyleHandle *value)
	Retrieves the art style object value of an entry.
AIAPI AIEntryRef(*	FromArtStyle )(AIArtStyleHandle value)
	Constructs an entry from a art style object value.
AIAPI AIErr(*	ToUnicodeString )(AIEntryRef entry, ai::UnicodeString &value)
	Retrieves the Unicode string value of an entry.
AIAPI AIEntryRef(*	FromUnicodeString )(const ai::UnicodeString &value)
	Constructs an entry from a Unicode string value.
AIAPI AIErr(*	AsUnicodeString )(AIEntryRef entry, ai::UnicodeString &value)
	Retrieves an entry as a Unicode string, if possible.
AIAPI ASBoolean(*	Equiv )(AIEntryRef entry1, AIEntryRef entry2)
	Reports whether two entries are equivalent.

---

Detailed Description

This suite provides functions for constructing and inspecting dictionary and array entries.

Entry objects associate a string key with a value of a given type (AIEntryType). Access array entries by integer index. Access dictionary entries by key, using the functions of the AIDictionarySuite.

• Functions with names "To<Type>" create entries of certain data types; for example, ToInteger() creates an integer entry from an integer value.
• Functions with names "From<Type>" retrieve the values of entries; for example, use FromInteger() to get an integer entry value.

See also:

AIArraySuite::MoveArtToEntry(),
AIArraySuite::MoveEntryToArt(),
AIDictionarySuite::MoveArtToEntry(),
AIDictionarySuite::MoveEntryToArt()

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIEntrySuite and kAIEntryVersion.

Entries, like the dictionaries and arrays that contain them, are reference counted. A function that returns an entry increments the count first. The caller must decrement the count when that entry is no longer needed to avoid memory leaks. For convenience, the "To<Type>" and AIDictionarySuite::Set() functions automatically decrement the reference count of the entry you pass in. This allows you to get the value of an entry in a container such as a dictionary with code like this:

ASBoolean value;
result = sAIEntry->ToBoolean(sAIDictionary->Get(dict, "MyKey"), &value);

Similarly, you can set an entry value in a container such as a dictionary with code like this:

result = sAIDictionary->Set(dict, "MyKey", sAIEntry->FromReal(15));

The GetType() and Equiv() functions do not consume the parameter; manage reference counts accordingly.

---

Member Data Documentation

AIAPI ai::int32(* AIEntrySuite::AddRef)(AIEntryRef entry)

Reference count maintenance.

increments the count of references to an entry.

Parameters:

entry

The entry object.

AIAPI AIErr(* AIEntrySuite::AsBoolean)(AIEntryRef entry, ASBoolean *value)

Retrieves a string entry as a boolean if possible.

Only valid for entries with value "1", "0", "true", or "false".

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the new value.

Returns:

The error kNoConversionErr if conversion is not possible.

AIAPI AIErr(* AIEntrySuite::AsInteger)(AIEntryRef entry, ai::int32 *value)

Retrieves a string entry as an integer if possible.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the new value.

Returns:

The error kNoConversionErr if conversion is not possible.

AIAPI AIErr(* AIEntrySuite::AsReal)(AIEntryRef entry, AIReal *value)

Retrieves a string entry as a real number if possible.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the new value.

Returns:

The error kNoConversionErr if conversion is not possible.

AIAPI AIErr(* AIEntrySuite::AsString)(AIEntryRef entry, const char **value)

Retrieves an entry as a string if possible.

Converts an integer, boolean, real, UID, UID reference, or Unicode string value to a platform-encoded string.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the new value. This block of memory is reused by the next call to this function; do not delete it. If needed, make a copy of the returned string before making another call to this function.

Returns:

The error kNoConversionErr if conversion is not possible.

AIAPI AIErr(* AIEntrySuite::AsUIDREF)(AIEntryRef entry, AIUIDREFRef *value)

Retrieves a string entry as a unique identifier if possible.

The string value must be in the form "id(\e uid )".

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the new value.

Returns:

The error kNoConversionErr if conversion is not possible.

AIAPI AIErr(* AIEntrySuite::AsUnicodeString)(AIEntryRef entry, ai::UnicodeString &value)

Retrieves an entry as a Unicode string, if possible.

Converts an integer, boolean, real, UID, UID reference, or platform-encoded string value to a Unicode string.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the new value.

Returns:

The error kNoConversionErr if conversion is not possible.

AIAPI ASBoolean(* AIEntrySuite::Equiv)(AIEntryRef entry1, AIEntryRef entry2)

Reports whether two entries are equivalent.

Equivalent entries have the same type and value. Two NULL entries are considered equivalent.

Parameters:

	entry1	The first entry.
	entry2	The second entry.

Returns:

True if the entries are equivalent, false otherwise.

AIAPI AIEntryRef(* AIEntrySuite::FromArray)(AIArrayRef value)

Constructs an entry from an array value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromArtStyle)(AIArtStyleHandle value)

Constructs an entry from a art style object value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromBinary)(void *value, size_t size)

Constructs an entry from a binary data value.

(Note that this function returns an entry object, not an error code.)

Parameters:

	value	The entry value.
	size	The number of bytes in the value buffer.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromBoolean)(ASBoolean value)

Constructs an entry from a boolean value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromBrushPattern)(AIPatternHandle value)

Constructs an entry from a brush pattern object value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromCustomColor)(AICustomColorHandle value)

Constructs an entry from a custom color object value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromDict)(AIDictionaryRef value)

Constructs an entry from a dictionary value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromFillStyle)(const struct AIFillStyle *value)

Constructs an entry from a fill style value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromGradient)(AIGradientHandle value)

Constructs an entry from a gradient object value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromInteger)(ai::int32 value)

Constructs an entry from an integer value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromPattern)(AIPatternHandle value)

Constructs an entry from a pattern object value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromPluginObject)(AIObjectHandle value)

Constructs an entry from a plug-in global object value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromReal)(AIReal value)

Constructs an entry from a real-number value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromRealMatrix)(const AIRealMatrix *value)

Constructs an entry from a transformation-matrix value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromRealPoint)(const AIRealPoint *value)

Constructs an entry from a point value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromString)(const char *value)

Constructs an entry from a string value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromStrokeStyle)(const struct AIStrokeStyle *value)

Constructs an entry from a stroke style value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromSVGFilterHandle)(AISVGFilterHandle value)

Constructs an entry from an SVG filter value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromSymbolPattern)(AIPatternHandle value)

Constructs an entry from a symbol pattern object value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromUID)(AIUIDRef value)

Constructs an entry from a unique identifier value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromUIDREF)(AIUIDREFRef value)

Constructs an entry from a unique identifier reference value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromUnicodeString)(const ai::UnicodeString &value)

Constructs an entry from a Unicode string value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryRef(* AIEntrySuite::FromXMLNode)(AIXMLNodeRef value)

Constructs an entry from an XML node value.

(Note that this function returns an entry object, not an error code.)

Parameters:

value

The entry value.

Returns:

The new entry object. The initial reference count is 1.

AIAPI AIEntryType(* AIEntrySuite::GetType)(AIEntryRef entry)

Retrieves the type of an entry.

Does not affect the reference count of the passed entry. (Note that this function returns a type value, not an error code.)

Parameters:

entry

The entry object

Returns:

The entry type.

AIAPI ai::int32(* AIEntrySuite::Release)(AIEntryRef entry)

Reference count maintenance.

decrements the count of references to an entry.

Parameters:

entry

The entry object.

AIAPI AIErr(* AIEntrySuite::ToArray)(AIEntryRef entry, AIArrayRef *value)

Retrieves the array value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToArt)(AIEntryRef entry, AIArtHandle *art)

Retrieves the art object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

See also:

AIArraySuite::MoveArtToEntry()
AIDictionarySuite::MoveArtToEntry().

AIAPI AIErr(* AIEntrySuite::ToArtStyle)(AIEntryRef entry, AIArtStyleHandle *value)

Retrieves the art style object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToBinary)(AIEntryRef entry, void *value, size_t *size)

Retrieves the binary data value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value, or NULL to retrieve the size needed for the value.
	size	[out] A buffer in which to return the number of bytes written to the value buffer, or the size needed if value is NULL.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

Note:

If you call the function twice to get the size needed and then retrieve the value, keep in mind that each call decrements the reference count of the entry.

AIAPI AIErr(* AIEntrySuite::ToBoolean)(AIEntryRef entry, ASBoolean *value)

Retrieves the boolean value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToBrushPattern)(AIEntryRef entry, AIPatternHandle *value)

Retrieves the brush pattern object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToCustomColor)(AIEntryRef entry, AICustomColorHandle *value)

Retrieves the custom color object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToDict)(AIEntryRef entry, AIDictionaryRef *value)

Retrieves the dictionary value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToFillStyle)(AIEntryRef entry, struct AIFillStyle *value)

Retrieves the fill style value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToGradient)(AIEntryRef entry, AIGradientHandle *value)

Retrieves the gradient object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToInteger)(AIEntryRef entry, ai::int32 *value)

Retrieves the integer value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToPattern)(AIEntryRef entry, AIPatternHandle *value)

Retrieves the pattern object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToPluginObject)(AIEntryRef entry, AIObjectHandle *value)

Retrieves the plug-in global object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToReal)(AIEntryRef entry, AIReal *value)

Retrieves the real-number value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToRealMatrix)(AIEntryRef entry, AIRealMatrix *value)

Retrieves the transformation-matrix value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToRealPoint)(AIEntryRef entry, AIRealPoint *value)

Retrieves the point value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToString)(AIEntryRef entry, const char **value)

Retrieves the string value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToStrokeStyle)(AIEntryRef entry, struct AIStrokeStyle *value)

Retrieves the stroke style value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToSVGFilterHandle)(AIEntryRef entry, AISVGFilterHandle *value)

Retrieves the SVG filter value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToSymbolPattern)(AIEntryRef entry, AIPatternHandle *value)

Retrieves the symbol pattern object value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToUID)(AIEntryRef entry, AIUIDRef *value)

Retrieves the unique identifier value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToUIDREF)(AIEntryRef entry, AIUIDREFRef *value)

Retrieves the unique identifier reference value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToUnicodeString)(AIEntryRef entry, ai::UnicodeString &value)

Retrieves the Unicode string value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

AIAPI AIErr(* AIEntrySuite::ToXMLNode)(AIEntryRef entry, AIXMLNodeRef *value)

Retrieves the XML node value of an entry.

Parameters:

	entry	The entry object. This call automatically decrements the reference count.
	value	[out] A buffer in which to return the value.

Returns:

The error kBadParameterErr if the entry is not of the correct type.

---

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

• AIEntry.h