DXGKDDI_MONITORSOURCEMODESET_ACQUIREPREFERREDMODEINFO callback function (d3dkmddi.h)

Article
05/26/2023

The pfnAcquirePreferredModeInfo returns a descriptor of the preferred mode in a specified monitor source mode set object.

Syntax

DXGKDDI_MONITORSOURCEMODESET_ACQUIREPREFERREDMODEINFO DxgkddiMonitorsourcemodesetAcquirepreferredmodeinfo;

NTSTATUS DxgkddiMonitorsourcemodesetAcquirepreferredmodeinfo(
  [in]  IN_CONST_D3DKMDT_HMONITORSOURCEMODESET hMonitorSourceModeSet,
  [out] DEREF_OUT_CONST_PPD3DKMDT_MONITOR_SOURCE_MODE ppFirstMonitorSourceModeInfo
)
{...}

Parameters

[in] hMonitorSourceModeSet

A handle to a monitor source mode set object. The display miniport driver previously obtained this handle by calling the pfnAcquireMonitorSourceModeSet function of the Monitor interface.

[out] ppFirstMonitorSourceModeInfo

A pointer to a variable that receives a pointer to a D3DKMDT_MONITOR_SOURCE_MODE structure. The structure contains a variety of information about the preferred monitor source mode, including its ID and video signal.

Return value

The pfnAcquirePreferredModeInfo function returns one of the following values.

Return code	Description
STATUS_SUCCESS	The function successfully returned a descriptor of the preferred mode.
STATIS_GRAPHICS_NO_PREFERRED_MODE	The function succeeded, but the specified monitor source mode set does not have a preferred mode.
STATUS_GRAPHICS_INVALID_MONITOR_SOURCEMODESET	The handle supplied in hMonitorSourceModeSet was invalid.

Remarks

When you have finished using the D3DKMDT_MONITOR_SOURCE_MODE structure, you must release the structure by calling pfnReleaseModeInfo.

The D3DKMDT_HMONITORSOURCEMODESET 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

Share via