Edit

D3DKMTGetOverlayState function (d3dkmthk.h)

  • Article

The D3DKMTGetOverlayState function retrieves the status about an overlay.

Syntax

NTSTATUS D3DKMTGetOverlayState(
  D3DKMT_GETOVERLAYSTATE *unnamedParam1
);

Parameters

unnamedParam1

pData [in, out]

A pointer to a D3DKMT_GETOVERLAYSTATE structure that describes parameters to retrieve status about an overlay.

Return value

D3DKMTGetOverlayState returns one of the following values:

Return code Description
STATUS_SUCCESS The status about an overlay was successfully retrieved.
STATUS_DEVICE_REMOVED The graphics adapter was stopped or the display device was reset.
STATUS_INVALID_PARAMETER Parameters were validated and determined to be incorrect.

This function might also return other NTSTATUS values.

Requirements

Requirement Value
Minimum supported client D3DKMTGetOverlayState is supported beginning with the Windows 7 operating system.
Target Platform Universal
Header d3dkmthk.h (include D3dkmthk.h)
Library Gdi32.lib
DLL Gdi32.dll

See also

D3DKMT_GETOVERLAYSTATE