DXGKDDI_QUERYADAPTERINFO callback function (d3dkmddi.h)

Article
05/26/2023

The DxgkDdiQueryAdapterInfo function retrieves configuration information from the graphics adapter.

Syntax

DXGKDDI_QUERYADAPTERINFO DxgkddiQueryadapterinfo;

NTSTATUS DxgkddiQueryadapterinfo(
  [in] IN_CONST_HANDLE hAdapter,
  [in] IN_CONST_PDXGKARG_QUERYADAPTERINFO pQueryAdapterInfo
)
{...}

Parameters

[in] hAdapter

A handle to a context block that is associated with a display adapter. The display miniport driver previously provided this handle to the Microsoft DirectX graphics kernel subsystem in the MiniportDeviceContext output parameter of the DxgkDdiAddDevice function.

[in] pQueryAdapterInfo

A pointer to a DXGKARG_QUERYADAPTERINFO structure that the display miniport driver fills with the configuration information for the graphics adapter.

Return value

DxgkDdiQueryAdapterInfo returns one of the following values:

Return code	Description
STATUS_SUCCESS	DxgkDdiQueryAdapterInfo successfully retrieved the configuration information.
STATUS_INVALID_PARAMETER	Parameters that were passed to DxgkDdiQueryAdapterInfo contained errors that prevented it from completing.
STATUS_NO_MEMORY	DxgkDdiQueryAdapterInfo could not allocate memory that was required for it to complete.
STATUS_GRAPHICS_DRIVER_MISMATCH	The display miniport driver is not compatible with the user-mode display driver that initiated the call to DxgkDdiQueryAdapterInfo (that is, supplied private data for a query to the display miniport driver).

Remarks

When the user-mode display driver calls the pfnQueryAdapterInfoCb function, a call to the DxgkDdiQueryAdapterInfo function is initiated. DxgkDdiQueryAdapterInfo receives the DXGKQAITYPE_UMDRIVERPRIVATE value in the Type member of the DXGKARG_QUERYADAPTERINFO structure that the pQueryAdapterInfo parameter points to. This function also receives a proprietary buffer in the pOutputData member that it fills with the configuration information that is necessary for the user-mode display driver to identify the adapter.

If the DirectX graphics kernel subsystem (which is part of Dxgkrnl.sys) specifies the DXGKQAITYPE_DRIVERCAPS value in the Type member of DXGKARG_QUERYADAPTERINFO when the subsystem calls DxgkDdiQueryAdapterInfo, the display miniport driver should populate the provided DXGK_DRIVERCAPS structure with information that the subsystem can use.

If the DirectX graphics kernel subsystem supplies the DXGKQAITYPE_QUERYSEGMENT value in the Type member of DXGKARG_QUERYADAPTERINFO, the display miniport driver should provide information about the memory segments that it supports. For more information about memory segments, see Initializing Use of Memory Segments.

DxgkDdiQueryAdapterInfo should be made pageable.

Note

All drivers that support WDDM 2.6 must implement the DxgkDdiQueryAdapterInfo callback.

Requirements

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