DXGKDDI_MONITOR_GETMONITORDESCRIPTORSET callback function

The pfnGetMonitorDescriptorSet function returns a handle to a monitor descriptor set object that is associated with a specified monitor.

Syntax

DXGKDDI_MONITOR_GETMONITORDESCRIPTORSET DxgkddiMonitorGetmonitordescriptorset;

NTSTATUS DxgkddiMonitorGetmonitordescriptorset(
  IN_CONST_D3DKMDT_ADAPTER hAdapter,
  IN_CONST_D3DDDI_VIDEO_PRESENT_TARGET_ID VideoPresentTargetId,
  OUT_PD3DKMDT_HMONITORDESCRIPTORSET phMonitorDescriptorSet,
  DEREF_OUT_CONST_PPDXGK_MONITORDESCRIPTORSET_INTERFACE ppMonitorDescriptorSetInterface
)
{...}

Parameters

hAdapter

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

VideoPresentTargetId

[in] An integer that identifies one of the video present targets on the display adapter. The returned monitor descriptor set object contains descriptors for the monitor that is connected to this video present target.

phMonitorDescriptorSet

[out] A pointer to a variable that receives a handle to a monitor descriptor set object.

ppMonitorDescriptorSetInterface

[out] A pointer to a variable that receives a pointer to a DXGK_MONITORDESCRIPTORSET_INTERFACE structure. The structure contains pointers to functions that the display miniport driver can call to inspect and alter the monitor descriptor set object.

Return Value

The pfnGetMonitorDescriptorSet function returns one of the following values.

Return code Description
STATUS_SUCCESS
The function succeeded.
STATUS_INVALID_PARAMETER
An invalid parameter was supplied.
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.

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.

You do not need to release the handle returned in phMonitorDescriptorSet.

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

Requirements

   
Windows version Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dkmddi.h (include D3dkmddi.h)
IRQL PASSIVE_LEVEL

See Also

DXGK_MONITOR_INTERFACE_V2

DxgkDdiEnumVidPnCofuncModality