DXGKDDI_VIDPNTARGETMODESET_ACQUIREFIRSTMODEINFO callback function

The pfnAcquireFirstModeInfo function returns a descriptor of the first mode in a specified VidPN target mode set.

Syntax

DXGKDDI_VIDPNTARGETMODESET_ACQUIREFIRSTMODEINFO DxgkddiVidpntargetmodesetAcquirefirstmodeinfo;

NTSTATUS DxgkddiVidpntargetmodesetAcquirefirstmodeinfo(
  IN_CONST_D3DKMDT_HVIDPNTARGETMODESET hVidPnTargetModeSet,
  DEREF_OUT_CONST_PPD3DKMDT_VIDPN_TARGET_MODE ppFirstVidPnTargetModeInfo
)
{...}

Parameters

hVidPnTargetModeSet

[in] A handle to a VidPN target mode set object. The display miniport driver previously obtained this handle by calling the pfnAcquireTargetModeSet function of the DXGK_VIDPN_INTERFACE interface.

ppFirstVidPnTargetModeInfo

[out] A pointer to a variable that receives a pointer to a D3DKMDT_VIDPN_TARGET_MODE structure. The structure contains a variety of information about the target mode, including its ID and video signal characteristics.

Return Value

The pfnAcquireFirstModeInfo function returns one of the following values:

Return code Description
STATUS_SUCCESS The function succeeded.
STATUS_GRAPHICS_INVALID_VIDPN_TARGETMODESET The handle supplied in hVidPnTargetModeSet was invalid.

Remarks

When you have finished using the D3DKMDT_VIDPN_TARGET_MODE structure, you must release the structure by calling pfnReleaseModeInfo.

You can enumerate all the modes that belong to a VidPN target mode set object by calling pfnAcquireFirstModeInfo and then making a sequence of calls to pfnAcquireNextModeInfo.

Requirements

   
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dkmddi.h (include D3dkmddi.h)
IRQL PASSIVE_LEVEL

See Also

D3DKMDT_VIDPN_TARGET_MODE

pfnAcquireNextModeInfo

pfnReleaseModeInfo