DXGK_MONITORSOURCEMODESET_INTERFACE::pfnAcquirePreferredModeInfo routine

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

Syntax


DXGKDDI_MONITORSOURCEMODESET_ACQUIREPREFERREDMODEINFO pfnAcquirePreferredModeInfo;

NTSTATUS APIENTRY pfnAcquirePreferredModeInfo(
  _In_   const D3DKMDT_HMONITORSOURCEMODESET hMonitorSourceModeSet,
  _Out_  const D3DKMDT_MONITOR_SOURCE_MODE **ppFirstMonitorSourceModeInfo
)
{ ... }

Parameters

hMonitorSourceModeSet [in]

[in] 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.

ppFirstMonitorSourceModeInfo [out]

[out] 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 codeDescription
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

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dkmddi.h (include D3dkmddi.h)

IRQL

PASSIVE_LEVEL

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.