DXGK_VIDPNTARGETMODESET_INTERFACE::pfnAcquirePinnedModeInfo routine

The pfnAcquirePinnedModeInfo function returns a descriptor of the pinned mode in a specified VidPN target mode set.

Syntax


DXGKDDI_VIDPNTARGETMODESET_ACQUIREPINNEDMODEINFO pfnAcquirePinnedModeInfo;

NTSTATUS APIENTRY pfnAcquirePinnedModeInfo(
  _In_   const D3DKMDT_HVIDPNTARGETMODESET hVidPnTargetModeSet,
  _Out_  const D3DKMDT_VIDPN_TARGET_MODE **ppPinnedVidPnTargetModeInfo
)
{ ... }

Parameters

hVidPnTargetModeSet [in]

[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.

ppPinnedVidPnTargetModeInfo [out]

[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 pinned mode, including its ID and video signal characteristics. If the target mode set identified by hVidPnTargetModeSet has no pinned mode, then this variable receives a NULL pointer.

Return value

The pfnAcquirePinnedModeInfo function returns one of the following values:

Return codeDescription
STATUS_SUCCESS

The function succeeded by doing one of the following:

Setting ppPinnedVidPnTargetModeInfo to the address of D3DKMDT_VIDPN_TARGET_MODE structure that describes the pinned mode.

Setting ppPinnedVidPnTargetModeInfo to NULL to indicate that the target mode set has no pinned mode.

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.

The D3DKMDT_HVIDPNTARGETMODESET data type is defined in D3dkmdt.h.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dkmddi.h (include D3dkmddi.h)

IRQL

PASSIVE_LEVEL

See also

pfnReleaseModeInfo
pfnPinMode
D3DKMDT_VIDPN_TARGET_MODE

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft