AIUUIDSuite Struct Reference
[API Suite List]

This suite is in an experimental state, it is not completely production-ready. More...

#include <AIUUID.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetArtHandle )(const ai::uuid &_uuid, AIArtHandle &art)
	Retrieves the art object associated with the UUID, if the art is in-scope.
AIAPI AIErr(*	GetArtUUID )(AIArtHandle art, ai::uuid &_uuid)
	Retrieves the UUID associated with the art.
AIAPI AIErr(*	UUIDToString )(const ai::uuid &_uuid, ai::UnicodeString &uStr)
	Retrieves the UnicodeString representation of the UUID.
AIAPI AIErr(*	StringToUUID )(const ai::UnicodeString &uStr, ai::uuid &_uuid)
	Retrieves the UUID object by creating it from the UnicodeString.
AIAPI AIErr(*	GenerateNewUUID )(ai::uuid &_uuid)
	Generates new unique UUID.

---

Detailed Description

This suite is in an experimental state, it is not completely production-ready.

These functions allow you to interact with the UUID and associated art

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIUUIDSuite and kAIUUIDVersion.

  See also:

  ai::uuid

---

Member Data Documentation

AIAPI AIErr(* AIUUIDSuite::GenerateNewUUID)(ai::uuid &_uuid)

Generates new unique UUID.

Parameters:

_uuid

[out] Reference variable in which the new generated uuid object is returned*

AIAPI AIErr(* AIUUIDSuite::GetArtHandle)(const ai::uuid &_uuid, AIArtHandle &art)

Retrieves the art object associated with the UUID, if the art is in-scope.

Parameters:

	_uuid	[in] const reference of UUID of art object.
	art	[out] A buffer in which to return the output as the valid art object, or a null pointer if the art object has been deleted or moved out of scope. This API may fail to provide the correct ArtHandle, if an object's dictionary is acquired but not released after use. (It is not recommended to acquire and hold the dictionary reference for future use)

AIAPI AIErr(* AIUUIDSuite::GetArtUUID)(AIArtHandle art, ai::uuid &_uuid)

Retrieves the UUID associated with the art.

Parameters:

	art	[in] The art object.
	_uuid	[out] Reference variable to return the UUID of the art object.

AIAPI AIErr(* AIUUIDSuite::StringToUUID)(const ai::UnicodeString &uStr, ai::uuid &_uuid)

Retrieves the UUID object by creating it from the UnicodeString.

Parameters:

	uStr	[in] UnicodeString from which the UUID needs to be created.
	_uuid	[out] Reference variable in which to return the UUID object created from the UnicodeString.

AIAPI AIErr(* AIUUIDSuite::UUIDToString)(const ai::uuid &_uuid, ai::UnicodeString &uStr)

Retrieves the UnicodeString representation of the UUID.

Parameters:

	_uuid	[in] Const reference of the UUID from which UnicodeString need to be created.
	uStr	[out] Reference variable in which to return the UnicodeString representation of UUID.

---

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

• AIUUID.h