DXGKDDI_MONITOR_ACQUIREMONITORSOURCEMODESET callback function (d3dkmddi.h)

Article
05/26/2023

The pfnAcquireMonitorSourceModeSet function returns a handle to the monitor source mode set object that is associated with a specified monitor.

Syntax

DXGKDDI_MONITOR_ACQUIREMONITORSOURCEMODESET DxgkddiMonitorAcquiremonitorsourcemodeset;

NTSTATUS DxgkddiMonitorAcquiremonitorsourcemodeset(
  [in]  IN_CONST_D3DKMDT_ADAPTER hAdapter,
  [in]  IN_CONST_D3DDDI_VIDEO_PRESENT_TARGET_ID VideoPresentTargetId,
  [out] OUT_PD3DKMDT_HMONITORSOURCEMODESET phMonitorSourceModeSet,
  [out] DEREF_OUT_CONST_PPDXGK_MONITORSOURCEMODESET_INTERFACE ppMonitorSourceModeSetInterface
)
{...}

Parameters

[in] hAdapter

A handle that identifies a display adapter. The Microsoft DirectX graphics kernel subsystem previously provided this handle to the display miniport driver in the DxgkInterface parameter of the DxgkDdiStartDevice function.

[in] VideoPresentTargetId

An integer that identifies one of the video present targets on the display adapter. The returned source mode set object describes the modes available on the monitor that is connected to this video present target.

[out] phMonitorSourceModeSet

A pointer to a variable that receives a handle to a monitor source mode set object.

[out] ppMonitorSourceModeSetInterface

A pointer to a variable that receives a pointer to a DXGK_MONITORSOURCEMODESET_INTERFACE structure. The structure contains pointers to functions that the display miniport driver can call to inspect and alter the monitor source mode set object.

Return value

The pfnAcquireMonitorSourceModeSet function returns one of the following values.

Return code	Description
STATUS_SUCCESS	The function succeeded.
STATUS_GRAPHICS_INVALID_DISPLAY_ADAPTER	The handle supplied in hAdapter was invalid.
STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET	The identifier supplied in VideoPresentTargetId was invalid.
STATUS_GRAPHICS_MONITOR_NOT_CONNECTED	There is no monitor connected to the video present target identified by VideoPresentTargetId.

This function might also return other error codes that are defined in Ntstatus.h.

Remarks

VidPN target identifiers are assigned by the display miniport driver. The DxgkDdiQueryChildRelations function, implemented by the display miniport driver, returns an array of DXGK_CHILD_DESCRIPTOR structures, each of which contains an identifier.

When you have finished using the monitor source mode set object handle, you must release the handle by calling pfnReleaseMonitorSourceModeSet. Target mode set objects are reference counted, so if you acquire a handle several times, you must release it that same number of times.

This function is also available in the DXGK_MONITOR_INTERFACE_V2 interface beginning with Windows 7.

Requirements

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