DXGKDDI_VIDPNTOPOLOGY_ACQUIRENEXTPATHINFO callback function (d3dkmddi.h)

Article
05/26/2023

The pfnAcquireNextPathInfo function returns a descriptor of the next video present path in a specified VidPN topology, given the current path.

Syntax

DXGKDDI_VIDPNTOPOLOGY_ACQUIRENEXTPATHINFO DxgkddiVidpntopologyAcquirenextpathinfo;

NTSTATUS DxgkddiVidpntopologyAcquirenextpathinfo(
  [in]  IN_CONST_D3DKMDT_HVIDPNTOPOLOGY hVidPnTopology,
  [in]  IN_CONST_PD3DKMDT_VIDPN_PRESENT_PATH_CONST pVidPnPresentPathInfo,
  [out] DEREF_OUT_CONST_PPD3DKMDT_VIDPN_PRESENT_PATH ppNextVidPnPresentPathInfo
)
{...}

Parameters

[in] hVidPnTopology

A handle to a VidPN topology object. The display miniport driver previously obtained this handle by calling the pfnGetTopology function of the DXGK_VIDPN_INTERFACE interface.

[in] pVidPnPresentPathInfo

A pointer to a D3DKMDT_VIDPN_PRESENT_PATH structure that describes the current path. The display miniport driver previously obtained this pointer by calling pfnAcquireFirstPathInfo or pfnAcquireNextPathInfo.

[out] ppNextVidPnPresentPathInfo

A pointer to a variable that receives a pointer to a D3DKMDT_VIDPN_PRESENT_PATH structure that describes the next path.

Return value

The pfnAcquireNextPathInfo function returns one of the following values:

Return code	Description
STATUS_SUCCESS	The function succeeded.
STATUS_GRAPHICS_INVALID_VIDPN_TOPOLOGY	The handle supplied in hVidPnTopology was invalid.

Remarks

When you have finished using the D3DKMDT_VIDPN_PRESENT_PATH structure, you must release the structure by calling pfnReleasePathInfo.

You can enumerate all the paths that belong to a VidPN topology object by calling pfnAcquireFirstPathInfo and then making a sequence of calls to pfnAcquireNextPathInfo.

The D3DKMDT_HVIDPNTOPOLOGY data type is defined in D3dkmdt.h.

Requirements

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