AIMdMemorySuite Struct Reference
[API Suite List]

This suite provides functions that allocate and dispose of blocks of memory. More...

#include <AIMdMemory.h>

List of all members.

Public Attributes
AIAPI AIErr(*	MdMemoryNewHandle )(size_t size, AIMdMemoryHandle *hMem)
	Allocates a memory block.
AIAPI AIErr(*	MdMemoryDisposeHandle )(AIMdMemoryHandle hMem)
	Frees the memory associated with a handle.
AIAPI AIErr(*	MdMemoryGetSize )(AIMdMemoryHandle hMem, size_t *size)
	Reports the size of an allocated memory block.
AIAPI AIErr(*	MdMemoryResize )(AIMdMemoryHandle hMem, size_t newSize)
	Reallocates a memory block.
AIAPI AIErr(*	MdMemoryLock )(AIMdMemoryHandle hMem, void **lockedPtr)
	Locks a memory block, so that the operating system does not move it.
AIAPI AIErr(*	MdMemoryUnLock )(AIMdMemoryHandle hMem)
	Unlocks a memory block that was locked with MdMemoryLock().

---

Detailed Description

This suite provides functions that allocate and dispose of blocks of memory.

This memory management scheme is generally deprecated. Do not use it to allocate memory. It is still used, however, by the AIMatchingArtSuite, whose functions return a handle that must be freed by the caller using MdMemoryDisposeHandle().

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIMdMemorySuite and kAIMdMemoryVersion.

---

Member Data Documentation

AIAPI AIErr(* AIMdMemorySuite::MdMemoryDisposeHandle)(AIMdMemoryHandle hMem)

Frees the memory associated with a handle.

Parameters:

hMem

The memory handle. Upon return, this is no longer valid.

Referenced by ai::ArtMatcher::clear().

AIAPI AIErr(* AIMdMemorySuite::MdMemoryGetSize)(AIMdMemoryHandle hMem, size_t *size)

Reports the size of an allocated memory block.

Parameters:

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

AIAPI AIErr(* AIMdMemorySuite::MdMemoryLock)(AIMdMemoryHandle hMem, void **lockedPtr)

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

This is no longer necessary, as the operating system no longer moves memory blocks.

Parameters:

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

AIAPI AIErr(* AIMdMemorySuite::MdMemoryNewHandle)(size_t size, AIMdMemoryHandle *hMem)

Allocates a memory block.

Parameters:

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

AIAPI AIErr(* AIMdMemorySuite::MdMemoryResize)(AIMdMemoryHandle hMem, size_t newSize)

Reallocates a memory block.

Parameters:

	hMem	The memory handle.
	newSize	The new number of bytes.

AIAPI AIErr(* AIMdMemorySuite::MdMemoryUnLock)(AIMdMemoryHandle hMem)

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

This is no longer necessary, as the operating system no longer moves memory blocks.

Parameters:

hMem

The memory handle.

---

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

• AIMdMemory.h