ID2D1Factory1::GetEffectProperties method (d2d1_1.h)

Retrieves the properties of an effect.

Syntax

HRESULT GetEffectProperties(
  [in]  REFCLSID        effectId,
  [out] ID2D1Properties **properties
);

[in] effectId

Type: REFCLSID

The ID of the effect to retrieve properties from.

[out] properties

When this method returns, contains the address of a pointer to the property interface that can be used to query the metadata of the effect.

Type: HRESULT

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

HRESULT	Description
S_OK	No error occurred.
D2DERR_EFFECT_IS_NOT_REGISTERED	The requested effect could not be found.
E_OUTOFMEMORY	Direct2D could not allocate sufficient memory to complete the call.

The returned effect properties will have all the mutable properties for the effect set to a default of NULL, or an empty value.

Value types will be zero-filled.
Blob and string types will be zero-length.
Array types will have length 1 and the element of the array will conform to the previous rules.

This method cannot be used to return the properties for any effect not visible to ID2D1DeviceContext::CreateEffect.

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