ApuHeapGetState

Returns the current state of the APU physical heap.

Syntax

HRESULT ApuHeapGetState(
         ApuHeapState *apuHeapState,
         UINT32 flags
)

Parameters

apuHeapState
Type: ApuHeapState *

[out] An ApuHeapState structure containing the state of the heap.

flags
Type: UINT32

[in, optional] Flag to indicate which heap to query: APU_ALLOC_CACHED (the default) for the cached heap, or APU_ALLOC_NONCACHED for the non-cached heap.

Return value

Type: HRESULT

This method can return one of the values shown in the following table (in addition to other error codes).

Return codes

Return code	Description
S_OK	Success.
E_INVALIDARG	Invalid arguments.
APU_E_HEAP_NOT_ALLOCATED	The APU heap has not been allocated (see ApuCreateHeap).

Remarks

This is a lightweight API call that simply copies the current heap state to the user provided state structure.

Requirements

Header: Declared in apu.h.

Library: Use acphal.lib.