AIUIDPoolSuite Struct Reference
[API Suite List]
These functions allow you to create, query, and manage name pools.
More...
#include <AIUID.h>
List of all members.
Public Attributes |
| AIAPI ai::int32(* | AddRef )(void *pool) |
| | Increments the reference count for a UID name pool.
|
| AIAPI ai::int32(* | Release )(void *pool) |
| | Decrements the reference count for a UID name pool, and frees the memory when the reference count is 0.
|
| AIAPI AIErr(* | GetPool )(const char *name, AINamePoolRef *pool) |
| | Retrieves a UID name pool by its name.
|
| AIAPI AIErr(* | NewUID )(AINamePoolRef pool, const ai::UnicodeString &name, AIUIDRef *uid) |
| | Creates a new unique identifier with a name from the name pool.
|
| AIAPI AIErr(* | GetUID )(AINamePoolRef pool, const ai::UnicodeString &name, AIUIDRef *uid) |
| | Retrieves the UIDRef from its name.
|
| AIAPI AIErr(* | NewUIDREF )(AINamePoolRef pool, const ai::UnicodeString &name, AIUIDREFRef *uidref) |
| | Creates a new reference to a unique identifier with a name from the name pool.
|
| AIAPI AIErr(* | NewUIDFromBase )(AINamePoolRef pool, const ai::UnicodeString &base, AIUIDRef *uid) |
| | Creates a new unique identifier with a unique name generated from a base name.
|
Detailed Description
These functions allow you to create, query, and manage name pools.
An identifier (UID) is unique within a given pool, and has a name which is also unique within that pool; see AINamePoolRef. Each UID can be stored in only one container, and only once within that container.
- See also:
AIUIDSuite, AIUIDREFSuite, AIUIDUtilsSuite
Member Data Documentation
Increments the reference count for a UID name pool.
When you create a pool, the initial count is 1. Use Release() to decrement the count. (Note that this function returns a numeric value, not an error code.)
- Parameters:
-
| pool | The UID name pool reference. |
- Returns:
- The current reference count.
Retrieves a UID name pool by its name.
Currently there is only one pool, for XML unique ID names. This pool is returned regardless of the name supplied.
- Parameters:
-
| name | Ignored. |
| pool | [out] A buffer in which to return the pool reference. |
Retrieves the UIDRef from its name.
- Parameters:
-
| pool | The UID name pool. |
| name | The UID name. |
| uid | [out] A buffer in which to return the UID object, or NULL if there is none. |
Creates a new unique identifier with a name from the name pool.
The new UID has an initial reference count of 1.
- Parameters:
-
| pool | The UID name pool. |
| name | Optional. A name that conforms to the syntax imposed by the pool, and that is not currently in use. If not specified, the function creates a unique name. |
| uid | [out] A buffer in which to return the UID object. |
Creates a new unique identifier with a unique name generated from a base name.
- Parameters:
-
| pool | The UID name pool. |
| name | Optional. A base name that conforms to the syntax imposed by the pool. If not specified, or if in use, the function creates a unique name. |
| uid | [out] A buffer in which to return the UID object. |
Creates a new reference to a unique identifier with a name from the name pool.
The new UID reference has an initial reference count of 1.
- Parameters:
-
| pool | The UID name pool. |
| name | Optional. A name that conforms to the syntax imposed by the pool, and that is not currently in use. If not specified, the function creates a unique name. |
| uidref | [out] A buffer in which to return the UID reference object. |
Decrements the reference count for a UID name pool, and frees the memory when the reference count is 0.
When you create a pool, the initial count is 1. Use AddRef() to increment the count. (Note that this function returns a numeric value, not an error code.)
- Parameters:
-
| pool | The UID name pool reference. |
- Returns:
- The current reference count.
The documentation for this struct was generated from the following file:
