Skip to content

Latest commit

 

History

History
82 lines (64 loc) · 2.91 KB

nf-d3dkmthk-d3dkmtenumadapters3.md

File metadata and controls

82 lines (64 loc) · 2.91 KB
UID title description ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.lib req.dll req.irql req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library targetos tech.root req.typenames ms.custom f1_keywords topic_type api_type api_location api_name dev_langs
NF:d3dkmthk.D3DKMTEnumAdapters3
D3DKMTEnumAdapters3 function (d3dkmthk.h)
The D3DKMTEnumAdapters3 function Supplies information for enumerating all graphics adapters on the system.
03/24/2020
D3DKMTEnumAdapters3 function
D3DKMTEnumAdapters3
d3dkmthk.h
D3dkmthk.h
Windows
Windows 10, version 2004
Gdi32.lib
Gdi32.dll
Windows
display
D3DKMTEnumAdapters3
D3DKMTEnumAdapters3
d3dkmthk/D3DKMTEnumAdapters3
apiref
DllExport
Gdi32.dll
D3DKMTEnumAdapters3
c++

D3DKMTEnumAdapters3 function

-description

Supplies information for enumerating graphics and display adapters on the system.

-parameters

-param unnamedParam1 [in/out]

A D3DKMT_ENUMADAPTERS3 structure. The caller passes in the array size and an empty array space. The callee verifies that there is enough room in the array, fills out the array, and passes back how much of the array was used.

-returns

This function returns NTSTATUS.

Return Code Description
STATUS_BUFFER_TOO_SMALL The provided array is too small to receive all the adapters.
STATUS_INVALID_PARAMETER The pEnumAdapters member is null or is otherwise an invalid memory region.
STATUS_NO_MEMORY Memory cannot be allocated to satisfy the operation.

-remarks

When D3DKMT_ENUMADAPTERS3::pAdapters is null, D3DKMT_ENUMADAPTERS3::NumAdapters is set to the maximum supported adapter count. Callees will commonly invoke the method, first, to retrieve the maximum supported adapter count.

When the callee successfully enumerates adapters, it becomes responsible for explicitly managing the lifespan of adapter D3DKMT_HANDLEs. These handles are returned to the callee through pEnumAdapters, and they must be closed with D3DKMTCloseAdapter.

Setting none of the D3DKMT_ENUMADAPTERS3::Filter flags will still enumerate adapters, but there are fewer adapters than D3DKMTEnumAdapters2 enumerates. ComputeOnly adapters are left out of the default enumeration, to avoid breaking applications. DisplayOnly adapters are also left out of the default enumeration.

-see-also

D3DKMT_ENUMADAPTERS3

D3DKMTCloseAdapter

PFND3DKMT_ENUMADAPTERS3

D3DKMTCloseAdapter