Expand Minimize

DxgkDdiGetNodeMetadata routine

From a provided adapter handle, returns the engine type and friendly name of an engine on a specified GPU node. Must be implemented by Windows Display Driver Model (WDDM) 1.3 and later display miniport drivers.

Syntax


DXGKDDI_GETNODEMETADATA DxgkDdiGetNodeMetadata;

NTSTATUS APIENTRY DxgkDdiGetNodeMetadata(
  _In_   const HANDLE hAdapter,
  _In_   UINT NodeOrdinal,
  _Out_  DXGKARG_GETNODEMETADATA *pGetNodeMetadata
)
{ ... }

Parameters

hAdapter [in]

[in] A handle that identifies a display adapter. The DirectX graphics kernel subsystem previously provided this handle to the display miniport driver in the DxgkInterface parameter of the DxgkDdiStartDevice function.

NodeOrdinal [in]

An index of a node for which engine information will be obtained. This node is within the physical adapter defined by the hAdapter parameter.

pGetNodeMetadata [out]

A pointer to a DXGKARG_GETNODEMETADATA structure that contains the engine type and friendly name of the engine specified by the NodeOrdinal parameter.

Return value

Returns one of the following values:

Return codeDescription
STATUS_SUCCESS

DxgkDdiGetNodeMetadata successfully retrieved the engine information.

STATUS_INVALID_PARAMETER

The caller-provided hAdapter or pGetNodeMetadata parameters are invalid, or the caller-provided value of NodeOrdinal is greater than or equal to the number of nodes on the adapter.

 

If the hAdapter and pGetNodeMetadata parameters are valid, and NodeOrdinal has a value in the range of 0 to (number of nodes - 1), all calls to this function must be successful.

Remarks

For more information on how to implement this function, see Enumerating GPU engine capabilities.

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Header

D3dkmddi.h (include D3dkmddi.h)

IRQL

PASSIVE_LEVEL

See also

DXGKARG_GETNODEMETADATA
DxgkDdiStartDevice

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft