Module memory Methods

AcquireAlignedMemory() returns a pointer to a block of memory at least size bytes whose address is a multiple of 16*sizeof(void *).

The format of the AcquireAlignedMemory method is:

  void *AcquireAlignedMemory(const size_t count,const size_t quantum)

A description of each parameter follows:

count

the number of quantum elements to allocate.

quantum

the number of bytes in each quantum.

AcquireWizardMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.

The format of the AcquireWizardMemory method is:

  void *AcquireWizardMemory(const size_t size)

A description of each parameter follows:

size

the size of the memory in bytes to allocate.

AcquireQuantumMemory() returns a pointer to a block of memory at least count * quantum bytes suitably aligned for any use.

The format of the AcquireQuantumMemory method is:

  void *AcquireQuantumMemory(const size_t count,const size_t quantum)

A description of each parameter follows:

count

the number of quantum elements to allocate.

quantum

the number of bytes in each quantum.

CopyWizardMemory() copies size bytes from memory area source to the destination. Copying between objects that overlap will take place correctly. It returns destination.

The format of the CopyWizardMemory method is:

  void *CopyWizardMemory(void *destination,const void *source,
    const size_t size)

A description of each parameter follows:

destination

the destination.

source

the source.

size

the size of the memory in bytes to allocate.

GetWizardMemoryMethods() gets the methods to acquire, resize, and destroy memory.

The format of the GetWizardMemoryMethods() method is:

  void GetWizardMemoryMethods(AcquireMemoryHandler *acquire_memory_handler,
    ResizeMemoryHandler *resize_memory_handler,
    DestroyMemoryHandler *destroy_memory_handler)

A description of each parameter follows:

acquire_memory_handler

method to acquire memory (e.g. malloc).

resize_memory_handler

method to resize memory (e.g. realloc).

destroy_memory_handler

method to destroy memory (e.g. free).

RelinquishAlignedMemory() frees memory acquired with AcquireAlignedMemory() or reuse.

The format of the RelinquishAlignedMemory method is:

  void *RelinquishAlignedMemory(void *memory)

A description of each parameter follows:

memory

A pointer to a block of memory to free for reuse.

RelinquishWizardMemory() zeros memory that has been allocated, frees it for reuse.

The format of the RelinquishWizardMemory method is:

  void *RelinquishWizardMemory(void *memory)

A description of each parameter follows:

memory

A pointer to a block of memory to free for reuse.

ResetWizardMemory() fills the first size bytes of the memory area pointed to by memory with the constant byte c.

The format of the ResetWizardMemory method is:

  void *ResetWizardMemory(void *memory,int byte,const size_t size)

A description of each parameter follows:

memory

A pointer to a memory allocation.

byte

Set the memory to this value.

size

Size of the memory to reset.

ResizeWizardMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.

The format of the ResizeWizardMemory method is:

  void *ResizeWizardMemory(void *memory,const size_t size)

A description of each parameter follows:

memory

A pointer to a memory allocation.

size

the new size of the allocated memory.

ResizeQuantumMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.

The format of the ResizeQuantumMemory method is:

  void *ResizeQuantumMemory(void *memory,const size_t count,
    const size_t quantum)

A description of each parameter follows:

memory

A pointer to a memory allocation.

count

the number of quantum elements to allocate.

quantum

the number of bytes in each quantum.

SetWizardMemoryMethods() sets the methods to acquire, resize, and destroy memory.

The format of the SetWizardMemoryMethods() method is:

  SetWizardMemoryMethods(AcquireMemoryHandler acquire_memory_handler,
    ResizeMemoryHandler resize_memory_handler,
    DestroyMemoryHandler destroy_memory_handler)

A description of each parameter follows:

acquire_memory_handler

method to acquire memory (e.g. malloc).

resize_memory_handler

method to resize memory (e.g. realloc).

destroy_memory_handler

method to destroy memory (e.g. free).