Edit

DXGKDDI_VIDPN_RELEASETARGETMODESET callback function (d3dkmddi.h)

  • Article

The pfnReleaseTargetModeSet function releases a handle to a target mode set object.

Syntax

DXGKDDI_VIDPN_RELEASETARGETMODESET DxgkddiVidpnReleasetargetmodeset;

NTSTATUS DxgkddiVidpnReleasetargetmodeset(
  [in] IN_CONST_D3DKMDT_HVIDPN hVidPn,
  [in] IN_CONST_D3DKMDT_HVIDPNTARGETMODESET hVidPnTargetModeSet
)
{...}

Parameters

[in] hVidPn

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

[in] hVidPnTargetModeSet

The handle to be released.

Return value

The pfnReleaseTargetModeSet 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_TARGETMODESET The handle supplied in hVidPnTargetModeSet was invalid.
STATUS_GRAPHICS_RESOURCES_NOT_RELATED The VidPN identified by hVidPn does not contain the target mode set identified by hVidPnTargetModeSet.

Remarks

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

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

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

The D3DKMDT_HVIDPN and D3DKMDT_HVIDPNTARGETMODESET 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

See also

pfnAcquireTargetModeSet

pfnCreateNewTargetModeSet