DXGKDDI_VIDPNTARGETMODESET_ACQUIREPINNEDMODEINFO callback function (d3dkmddi.h)

Article
02/22/2024

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

Syntax

DXGKDDI_VIDPNTARGETMODESET_ACQUIREPINNEDMODEINFO DxgkddiVidpntargetmodesetAcquirepinnedmodeinfo;

NTSTATUS DxgkddiVidpntargetmodesetAcquirepinnedmodeinfo(
  [in]  IN_CONST_D3DKMDT_HVIDPNTARGETMODESET hVidPnTargetModeSet,
  [out] DEREF_OUT_CONST_PPD3DKMDT_VIDPN_TARGET_MODE ppPinnedVidPnTargetModeInfo
)
{...}

Parameters

[in] hVidPnTargetModeSet

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.

[out] ppPinnedVidPnTargetModeInfo

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 code	Description
STATUS_SUCCESS	The function succeeded by doing one of the following: 1. Setting ppPinnedVidPnTargetModeInfo to the address of D3DKMDT_VIDPN_TARGET_MODE structure that describes the pinned mode. 2. 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

Requirement	Value
Minimum supported client	Windows Vista
Target Platform	Desktop
Header	d3dkmddi.h (include D3dkmddi.h)
IRQL	PASSIVE_LEVEL