DXGKDDI_VIDPNTOPOLOGY_RELEASEPATHINFO callback function (d3dkmddi.h)

Article
05/26/2023

The pfnReleasePathInfo function releases a D3DKMDT_VIDPN_PRESENT_PATH structure that the VidPN manager previously provided to the display miniport driver.

Syntax

DXGKDDI_VIDPNTOPOLOGY_RELEASEPATHINFO DxgkddiVidpntopologyReleasepathinfo;

NTSTATUS DxgkddiVidpntopologyReleasepathinfo(
  [in] IN_CONST_D3DKMDT_HVIDPNTOPOLOGY hVidPnTopology,
  [in] IN_CONST_PD3DKMDT_VIDPN_PRESENT_PATH_CONST pVidPnPresentPathInfo
)
{...}

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 the D3DKMDT_VIDPN_PRESENT_PATH structure that is to be released.

Return value

The pfnReleasePathInfo 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.
STATUS_GRAPHICS_INVALID_VIDPN_PRESENT_PATH	The pointer supplied in pVidPnPresentPathInfo was invalid.

Remarks

When you have finished using a D3DKMDT_VIDPN_PRESENT_PATH structure that you obtained by calling any of the following functions, you must release the structure by calling pfnReleasePathInfo.

If you obtain a D3DKMDT_VIDPN_PRESENT_PATH structure by calling pfnCreateNewPathInfo and then pass that structure to pfnAddPath, you do not need to release the structure.

If you obtain a handle by calling pfnCreateNewPathInfo and then you decide not to add the new path to a topology, you must release the newly created structire by calling pfnReleasePathInfo.

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