AIPlatformMemorySuite Struct Reference
[API Suite List]

This suite provides functions with which to manage memory for ASSliceSettings values, used with the AIOptimizationSettingsSuite. More...

#include <AIPlatformMemory.h>

List of all members.

Public Attributes
ASAPI ASErr(*	New )(size_t size, ASHandle *handle)
	Allocates a block of memory.
ASAPI ASErr(*	Delete )(ASHandle handle)
	Frees a block of memory allocated with New().
ASAPI ASErr(*	GetSize )(ASHandle handle, size_t *size)
	Retrieves the size of a block of memory allocated with New().
ASAPI ASErr(*	Resize )(ASHandle *handle, size_t newSize)
	Resizes a block of memory allocated with New().
ASAPI ASErr(*	Lock )(ASHandle handle, void **dataPtr)
	Locks a memory block, so that the operating system does not move it.
ASAPI ASErr(*	UnLock )(ASHandle handle)
	Unlocks a memory block that was locked with Lock().

---

Detailed Description

This suite provides functions with which to manage memory for ASSliceSettings values, used with the AIOptimizationSettingsSuite.

Do not use them for other memory management. In general, use the AIBlockSuite or SPBlocksSuite to allocate memory.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIPlatformMemorySuite and kAIPlatformMemoryVersion.

---

Member Data Documentation

ASAPI ASErr(* AIPlatformMemorySuite::Delete)(ASHandle handle)

Frees a block of memory allocated with New().

Parameters:

handle

The memory handle object.

ASAPI ASErr(* AIPlatformMemorySuite::GetSize)(ASHandle handle, size_t *size)

Retrieves the size of a block of memory allocated with New().

Parameters:

	handle	The memory handle object.
	size	[out] A buffer in which to return the number of bytes allocated.

ASAPI ASErr(* AIPlatformMemorySuite::Lock)(ASHandle handle, void **dataPtr)

Locks a memory block, so that the operating system does not move it.

This is the equivalent of HLock() in Mac OS or GlobalLock() in Windows.

Parameters:

	handle	The memory handle.
	dataPtr	[out] A buffer in which to return a pointer to the locked memory block.

ASAPI ASErr(* AIPlatformMemorySuite::New)(size_t size, ASHandle *handle)

Allocates a block of memory.

Parameters:

	size	The number of bytes to allocate.
	handle	[out] A buffer in which to return the memory handle object.

ASAPI ASErr(* AIPlatformMemorySuite::Resize)(ASHandle *handle, size_t newSize)

Resizes a block of memory allocated with New().

Parameters:

	handle	[in, out] A buffer in which to pass the old object and return the resized object.
	newSize	The number of bytes to allocate.

ASAPI ASErr(* AIPlatformMemorySuite::UnLock)(ASHandle handle)

Unlocks a memory block that was locked with Lock().

Parameters:

handle

The memory handle.

---

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

• AIPlatformMemory.h