DXGKDDI_VIDPN_RELEASESOURCEMODESET callback function (d3dkmddi.h)

Article
05/26/2023

The pfnReleaseSourceModeSet function releases a handle to a source mode set object.

Syntax

DXGKDDI_VIDPN_RELEASESOURCEMODESET DxgkddiVidpnReleasesourcemodeset;

NTSTATUS DxgkddiVidpnReleasesourcemodeset(
  [in] IN_CONST_D3DKMDT_HVIDPN hVidPn,
  [in] IN_CONST_D3DKMDT_HVIDPNSOURCEMODESET hVidPnSourceModeSet
)
{...}

Parameters

[in] hVidPn

A handle to the VidPN object that contains the source mode set object. The VidPN manager previously provided this handle to the display miniport driver by calling DxgkDdiEnumVidPnCofuncModality, DxgkDdiIsSupportedVidPn, or DxgkDdiRecommendFunctionalVidPn.

[in] hVidPnSourceModeSet

The handle to be released.

Return value

The pfnReleaseSourceModeSet function returns one of the following values:

Return code	Description
STATUS_SUCCESS	The function succeeded.
STATUS_GRAPHICS_INVALID_VIDPN	The handle supplied in hVidPn was invalid.
STATUS_GRAPHICS_INVALID_VIDPN_SOURCEMODESET	The handle supplied in hVidPnSourceModeSet was invalid.
STATUS_GRAPHICS_RESOURCES_NOT_RELATED	The VidPN identified by hVidPn does not contain the source mode set identified by hVidPnSourceModeSet.

Remarks

When you have finished using a handle that you obtained by calling pfnAcquireSourceModeSet, you must release the handle by calling pfnReleaseSourceModeSet.

If you obtain a handle by calling pfnCreateNewSourceModeSet and then pass that handle to pfnAssignSourceModeSet, you do not need to release the handle.

If you obtain a handle by calling pfnCreateNewSourceModeSet and then you decide not to assign the new source mode set to a source, you must release the newly obtained handle by calling pfnReleaseSourceModeSet.

The D3DKMDT_HVIDPN and D3DKMDT_HVIDPNSOURCEMODESET data types are defined in D3dkmdt.h.

Requirements

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