AIUIDSuite Struct Reference
[API Suite List]

This suite allows you to access and manage unique identifiers. More...

#include <AIUID.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	AddRef )(void *uid)
	Increments the reference count for a unique identifier.
AIAPI ai::int32(*	Release )(void *uid)
	Decrements the reference count for a unique identifier, and frees the memory when the reference count is 0.
AIAPI AIBoolean(*	IsInUse )(AIUIDRef uid)
	Reports whether a unique identifier is currently stored within some container.
AIAPI void(*	GetPool )(AIUIDRef uid, AINamePoolRef *pool)
	Retrieves the UID name pool to which a unique identifier's name belongs.
AIAPI AIErr(*	GetName )(AIUIDRef uid, ai::UnicodeString &name)
	Retrieves the name of a unique identifier as a Unicode string.
AIAPI AIEntryRef(*	GetContainer )(AIUIDRef uid)
	Retrieves the dictionary or array that contains a unique identifier.
AIAPI AIErr(*	NewUIDREF )(AIUIDRef uid, AIUIDREFRef *ruidref)
	Creates a new reference to a unique identifier.

---

Detailed Description

This suite allows you to access and manage unique identifiers.

A unique identifier (UID) is an object that can be stored in a dictionary or an array. A unique identifier cannot occur in more than one container, or more than once in a container.

Given a unique ID, you can find its container. For example, unique IDs are typically found in the dictionary of an art object. Given such an ID, you can access the associated art object. An art object name is itself stored as a specially encoded unique ID in the associated art object dictionary.

See also:

AIUIDPoolSuite, AIUIDREFSuite, AIUIDUtilsSuite

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIUIDSuite and kAIUIDVersion.

---

Member Data Documentation

AIAPI ai::int32(* AIUIDSuite::AddRef)(void *uid)

Increments the reference count for a unique identifier.

When you create a UID, the initial count is 1. Use Release() to decrement the count. (Note that this function returns a numeric value, not an error code.)

Parameters:

uid

The UID object.

Returns:

The current reference count.

AIAPI AIEntryRef(* AIUIDSuite::GetContainer)(AIUIDRef uid)

Retrieves the dictionary or array that contains a unique identifier.

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

Parameters:

uid

The UID object.

Returns:

The entry object, or a NULL reference if the UID is not stored in a container.

See also:

AIEntrySuite

AIAPI AIErr(* AIUIDSuite::GetName)(AIUIDRef uid, ai::UnicodeString &name)

Retrieves the name of a unique identifier as a Unicode string.

Parameters:

	uid	The UID object.
	name	[out] A buffer in which to return the name.

AIAPI void(* AIUIDSuite::GetPool)(AIUIDRef uid, AINamePoolRef *pool)

Retrieves the UID name pool to which a unique identifier's name belongs.

(Note that this function does not return an error code.)

Parameters:

	uid	The UID object.
	pool	[out] A buffer in which to return the UID name pool, or NULL if the UID is not valid.

AIAPI AIBoolean(* AIUIDSuite::IsInUse)(AIUIDRef uid)

Reports whether a unique identifier is currently stored within some container.

A UID cannot occur in more than one container, or more than once in a container. (Note that this function returns a boolean value, not an error code.)

Parameters:

uid

The UID object.

Returns:

True if the UID is contained in a dictionary or array.

AIAPI AIErr(* AIUIDSuite::NewUIDREF)(AIUIDRef uid, AIUIDREFRef *ruidref)

Creates a new reference to a unique identifier.

The new UID reference has an initial reference count of 1.

Parameters:

	uid	The UID object.
	ruidref	[out] A buffer in which to return the UID reference object.

AIAPI ai::int32(* AIUIDSuite::Release)(void *uid)

Decrements the reference count for a unique identifier, and frees the memory when the reference count is 0.

When you create a UID, the initial count is 1. Use AddRef() to increment the count. (Note that this function returns a numeric value, not an error code.)

Parameters:

uid

The UID object.

Returns:

The current reference count.

---

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

• AIUID.h