DXGKDDI_MONITOR_RELEASEADDITIONALMONITORMODESET callback function (d3dkmddi.h)

Article
06/10/2023

The pfnReleaseAdditionalMonitorModeSet function releases 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_RELEASEADDITIONALMONITORMODESET DxgkddiMonitorReleaseadditionalmonitormodeset;

NTSTATUS DxgkddiMonitorReleaseadditionalmonitormodeset(
  [in] IN_CONST_D3DKMDT_ADAPTER hAdapter,
  [in] IN_CONST_D3DDDI_VIDEO_PRESENT_TARGET_ID VideoPresentTargetId,
  [in] IN_CONST_PDXGK_TARGETMODE_DETAIL_TIMING pAdditionalModesSet
)
{...}

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

[in] pAdditionalModesSet

A pointer to a variable that receives a DXGK_TARGETMODE_DETAIL_TIMING structure that describes a video present target's additional timing modes that are compatible with the display device. This structure was initially obtained in a call to pfnGetAdditionalMonitorModeSet.

Return value

The pfnReleaseAdditionalMonitorModeSet 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_INVALID_MONITOR_SOURCEMODESET	The handle supplied in ppAdditionalModesSet was invalid.

Remarks

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