Edit

DXGKDDI_MONITORDESCRIPTORSET_ACQUIREFIRSTDESCRIPTORINFO callback function (d3dkmddi.h)

  • Article

The pfnAcquireFirstDescriptorInfo function returns the first descriptor in a monitor descriptor set object.

Syntax

DXGKDDI_MONITORDESCRIPTORSET_ACQUIREFIRSTDESCRIPTORINFO DxgkddiMonitordescriptorsetAcquirefirstdescriptorinfo;

NTSTATUS DxgkddiMonitordescriptorsetAcquirefirstdescriptorinfo(
  [in]  IN_CONST_D3DKMDT_HMONITORDESCRIPTORSET hMonitorDescriptorSet,
  [out] DEREF_OUT_CONST_PPD3DKMDT_MONITOR_DESCRIPTOR ppFirstMonitorDescriptorInfo
)
{...}

Parameters

[in] hMonitorDescriptorSet

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

[out] ppFirstMonitorDescriptorInfo

A pointer to a variable that receives a pointer to a D3DKMDT_MONITOR_DESCRIPTOR structure. The structure is the first descriptor in the set.

Return value

The pfnAcquireFirstDescriptorInfo function returns one of the following values.

Return code Description
STATUS_SUCCESS The function successfully returned the first descriptor in the set.
STATUS_GRAPHICS_DATASET_IS_EMPTY The function succeeded, but there were no descriptors in the set.
STATUS_INVALID_PARAMETER An invalid parameter was supplied.
STATUS_GRAPHICS_INVALID_MONITOR_DESCRIPTORSET The handle supplied in hMonitorDescriptorSet was invalid.

Remarks

When you have finished using the D3DKMDT_MONITOR_DESCRIPTOR structure, you must release the structure by calling pfnReleaseDescriptorInfo.

You can obtain all the descriptors in a monitor descriptor set by calling pfnAcquireFirstDescriptorInfo and then making a sequence of calls to pfnAcquireNextDescriptorInfo.

Requirements

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