AIStringPoolSuite Struct Reference
[API Suite List]

This suite provides functions for working with string pools. More...

#include <AIStringPool.h>

List of all members.

Public Attributes
AIAPI AIErr(*	AllocateStringPool )(AIStringPool **pool)
	Creates a new string pool.
AIAPI AIErr(*	DisposeStringPool )(AIStringPool *pool)
	Disposes of a string pool that was created with AllocateStringPool().
AIAPI AIErr(*	MakeWString )(AIStringPool *pool, const char *string, char **wstring)
	Retrieves a string entry from a string pool, or creates it and adds it to the pool if it is not already there.

---

Detailed Description

This suite provides functions for working with string pools.

A string pool contains a collection of NULL-terminated character sequences. No single string appears in the pool more than once. You can compare two strings from the pool for equality by comparing their addresses. You can obtain the application string pool using AIRuntimeSuite::GetAppStringPool(), or you can use these functions to create your own string pool.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIStringPoolSuite and kAIStringPoolVersion.

---

Member Data Documentation

AIAPI AIErr(* AIStringPoolSuite::AllocateStringPool)(AIStringPool **pool)

Creates a new string pool.

The plug-in is responsible for freeing the pool when it is no longer needed.

Parameters:

pool

[out] A buffer in which to return the new string pool object.

AIAPI AIErr(* AIStringPoolSuite::DisposeStringPool)(AIStringPool *pool)

Disposes of a string pool that was created with AllocateStringPool().

Parameters:

pool

The string pool object.

AIAPI AIErr(* AIStringPoolSuite::MakeWString)(AIStringPool *pool, const char *string, char **wstring)

Retrieves a string entry from a string pool, or creates it and adds it to the pool if it is not already there.

Parameters:

	pool	The string pool object.
	string	The string value of the matching or new pool entry.
	wstring	[out] A buffer in which to return the pool entry.

---

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

• AIStringPool.h