DXGKDDI_MONITOR_GETADDITIONALMONITORMODESET callback function (d3dkmddi.h)

Article
06/10/2023

The pfnGetAdditionalMonitorModeSet function returns a handle to an additional monitor source mode set object that is associated with a specified monitor. It is available in the DXGK_MONITOR_INTERFACE_V2 interface, starting in Windows 7.

Syntax

DXGKDDI_MONITOR_GETADDITIONALMONITORMODESET DxgkddiMonitorGetadditionalmonitormodeset;

NTSTATUS DxgkddiMonitorGetadditionalmonitormodeset(
  [in]  IN_CONST_D3DKMDT_ADAPTER hAdapter,
  [in]  IN_CONST_D3DDDI_VIDEO_PRESENT_TARGET_ID VideoPresentTargetId,
  [out] OUT_PUINT pNumberModes,
  [out] DEREF_ECOUNT_PPDXGK_TARGETMODE_DETAIL_TIMING ppAdditionalModesSet
)
{...}

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 ppAdditionalModesSet additional modes set object describes the additional monitor source mode sets that are available on the monitor that is connected to this video present target.

[out] pNumberModes

A pointer to a variable that contains the number of additional timing modes of the video present target specified by VideoPresentTargetId.

[out] ppAdditionalModesSet

A pointer to a variable that receives a pointer to a DXGK_TARGETMODE_DETAIL_TIMING structure. The structure describes a video present target's additional timing modes that are compatible with the display device.

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.
STATUS_NOT_FOUND	The video present target identified by VideoPresentTargetId could not be found.

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.

This function is available beginning with Windows 7.

Requirements

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