DXGKDDI_VIDPNTOPOLOGY_RELEASEPATHINFO callback function

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_CONST_D3DKMDT_HVIDPNTOPOLOGY hVidPnTopology,
  IN_CONST_PD3DKMDT_VIDPN_PRESENT_PATH_CONST pVidPnPresentPathInfo
)
{...}

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.

pVidPnPresentPathInfo

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

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.

pfnAcquireFirstPathInfo

pfnAcquireNextPathInfo

pfnAcqirePathInfo

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

   
Windows Driver kit version
Target platform Desktop
Minimum KMDF version
Minimum UMDF version
Header d3dkmddi.h (include D3dkmddi.h)
Library
IRQL PASSIVE_LEVEL
DDI compliance rules

See Also

pfnAcquireFirstPathInfo
pfnAcquireNextPathInfo
pfnAcqirePathInfo
D3DKMDT_VIDPN_PRESENT_PATH

Send comments about this topic to Microsoft