DXGKDDI_VIDPNTOPOLOGY_ACQUIREFIRSTPATHINFO callback function (d3dkmddi.h)

The pfnAcquireFirstPathInfo structure returns a descriptor of the first path in a specified VidPN topology object.

Syntax

DXGKDDI_VIDPNTOPOLOGY_ACQUIREFIRSTPATHINFO DxgkddiVidpntopologyAcquirefirstpathinfo;

NTSTATUS DxgkddiVidpntopologyAcquirefirstpathinfo(
  IN_CONST_D3DKMDT_HVIDPNTOPOLOGY hVidPnTopology,
  DEREF_OUT_CONST_PPD3DKMDT_VIDPN_PRESENT_PATH ppFirstVidPnPresentPathInfo
)
{...}

Parameters

hVidPnTopology

[in] 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.

ppFirstVidPnPresentPathInfo

[out] A pointer to a variable that receives a pointer to a D3DKMDT_VIDPN_PRESENT_PATH structure. The structure contains a variety of information about the path, including the path's source and target identifiers.

Return value

The pfnAcquireFirstPathInfo 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

   
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dkmddi.h (include D3dkmddi.h)
IRQL PASSIVE_LEVEL

See also

D3DKMDT_VIDPN_PRESENT_PATH

pfnAcqirePathInfo

pfnAcquireNextPathInfo

pfnReleasePathInfo