CLocalHeap Class

 

The latest version of this topic can be found at CLocalHeap Class.

This class implements IAtlMemMgr using the Win32 local heap functions.

Important

This class and its members cannot be used in applications that execute in the Windows Runtime.

Syntax

class CLocalHeap : public IAtlMemMgr

Members

Public Methods

Name	Description
CLocalHeap::Allocate	Call this method to allocate a block of memory.
CLocalHeap::Free	Call this method to free a block of memory allocated by this memory manager.
CLocalHeap::GetSize	Call this method to get the allocated size of a memory block allocated by this memory manager.
CLocalHeap::Reallocate	Call this method to reallocate memory allocated by this memory manager.

Remarks

CLocalHeap implements memory allocation functions using the Win32 local heap functions.

Note

The local heap functions are slower than other memory management functions and do not provide as many features. Therefore, new applications should use the heap functions. These are available in the CWin32Heap class.

Example

See the example for IAtlMemMgr.

Inheritance Hierarchy

IAtlMemMgr

CLocalHeap

Requirements

Header: atlmem.h

CLocalHeap::Allocate

Call this method to allocate a block of memory.

virtual __declspec(allocator) void* Allocate(size_t nBytes) throw();

Parameters

nBytes
The requested number of bytes in the new memory block.

Return Value

Returns a pointer to the start of the newly allocated memory block.

Remarks

Call CLocalHeap::Free or CLocalHeap::Reallocate to free the memory allocated by this method.

Implemented using LocalAlloc with a flag parameter of LMEM_FIXED.

CLocalHeap::Free

Call this method to free a block of memory allocated by this memory manager.

virtual void Free(void* p) throw();

Parameters

p
Pointer to memory previously allocated by this memory manager. NULL is a valid value and does nothing.

Remarks

Implemented using LocalFree.

CLocalHeap::GetSize

Call this method to get the allocated size of a memory block allocated by this memory manager.

virtual size_t GetSize(void* p) throw();

Parameters

p
Pointer to memory previously allocated by this memory manager.

Return Value

Returns the size of the allocated memory block in bytes.

Remarks

Implemented using LocalSize.

CLocalHeap::Reallocate

Call this method to reallocate memory allocated by this memory manager.

virtual __declspec(allocator) void* Reallocate(void* p, size_t nBytes) throw();

Parameters

p
Pointer to memory previously allocated by this memory manager.

nBytes
The requested number of bytes in the new memory block.

Return Value

Returns a pointer to the start of the newly allocated memory block.

Remarks

Call CLocalHeap::Free to free the memory allocated by this method.

Implemented using LocalReAlloc.

See Also

Class Overview
CComHeap Class
CWin32Heap Class
CGlobalHeap Class
CCRTHeap Class
IAtlMemMgr Class