QueryMemoryResourceNotification function

Retrieves the state of the specified memory resource object.

Syntax

BOOL QueryMemoryResourceNotification(
  HANDLE ResourceNotificationHandle,
  PBOOL  ResourceState
);

Parameters

ResourceNotificationHandle

A handle to a memory resource notification object. The CreateMemoryResourceNotification function returns this handle.

ResourceState

The memory pointed to by this parameter receives the state of the memory resource notification object. The value of this parameter is set to TRUE if the specified memory condition exists, and FALSE if the specified memory condition does not exist.

Return Value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. For more error information, call GetLastError.

Remarks

Unlike the wait functions, QueryMemoryResourceNotification does not block the calling thread. Therefore, it is an efficient way to check the state of physical memory before proceeding with an operation.

To compile an application that uses this function, define the _WIN32_WINNT macro as 0x0501 or later. For more information, see Using the Windows Headers.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header memoryapi.h (include Windows.h, Memoryapi.h)
Library Kernel32.lib
DLL Kernel32.dll

See Also

CreateMemoryResourceNotification

Memory Management Functions