DxgkCbEnumHandleChildren routine

The DxgkCbEnumHandleChildren function enumerates all of the allocations that are associated with a given resource, one allocation at a time.

Syntax


DXGKCB_ENUMHANDLECHILDREN DxgkCbEnumHandleChildren;

D3DKMT_HANDLE APIENTRY DxgkCbEnumHandleChildren(
  _In_  const DXGKARGCB_ENUMHANDLECHILDREN *pData
)
{ ... }

Parameters

pData [in]

[in] A pointer to a DXGKARGCB_ENUMHANDLECHILDREN structure that describes the parent resource and the index of the child allocation to retrieve.

Return value

DxgkCbEnumHandleChildren returns the graphics subsystem-specific handle to the child allocation that the pData parameter describes. To retrieve the device-specific data for the handle, the display miniport driver must call the DxgkCbGetHandleData function.

DxgkCbEnumHandleChildren returns a NULL handle if the child-allocation index that the Index member of the DXGKARGCB_ENUMHANDLECHILDREN structure supplies exceeds the number of allocations that are associated with the parent resource. If DxgkCbEnumHandleChildren unexpectedly returns a NULL handle, the Microsoft DirectX graphics kernel subsystem was unable to resolve the handle to the parent resource because, for example, of the following possible reasons:

  • An invalid handle was received from the user-mode display driver because of a malicious attack or some other bug.
  • Allocations had lifetime issues.

If a NULL handle is returned unexpectedly, the display miniport driver should fail its currently running DDI function with STATUS_INVALID_HANDLE.

Remarks

The display miniport driver can call the DxgkCbEnumHandleChildren function in a loop to enumerate all of the allocations that are associated with a resource. If the display miniport driver sets the Index member of the DXGKARGCB_ENUMHANDLECHILDREN structure that is pointed to by the pData parameter to 0, DxgkCbEnumHandleChildren returns the first allocation handle; if Index is set to 1, DxgkCbEnumHandleChildren returns the second allocation handle; and so on. If Index is greater than the number of allocations that are associated with the resource, DxgkCbEnumHandleChildren returns NULL.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dkmddi.h (include D3dkmddi.h)

IRQL

< DISPATCH_LEVEL

See also

DXGKARGCB_ENUMHANDLECHILDREN
DxgkCbGetHandleData

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft