Edit

ID2D1Factory1::UnregisterEffect method (d2d1_1.h)

  • Article

Unregisters an effect within the factory instance that corresponds to the classId provided.

Syntax

HRESULT UnregisterEffect(
  [in] REFCLSID classId
);

Parameters

[in] classId

Type: REFCLSID

The identifier of the effect to be unregistered.

Return value

Type: HRESULT

D2DERR_EFFECT_IS_NOT_REGISTERED if the effect is not registered, S_OK otherwise.

Remarks

In order for the effect to be fully unloaded, you must call UnregisterEffect the same number of times that you have registered the effect.

The UnregisterEffect method unregisters only those effects that are registered on the same factory. It cannot be used to unregister a built-in effect.

Requirements

Requirement Value
Minimum supported client Windows 8 and Platform Update for Windows 7 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | UWP apps]
Target Platform Windows
Header d2d1_1.h
Library D2d1.lib
DLL D2d1.dll

See also

ID2D1Factory1

ID2D1Factory1::RegisterEffect