Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ID2D1Factory1::GetRegisteredEffects method

Returns the class IDs of the currently registered effects and global effects on this factory.

Syntax


HRESULT GetRegisteredEffects(
  [out]            CLSID *effects,
  UINT32 effectCount,
  [out]            UINT32 *effectsReturned,
  [out, optional]  UINT32 *effectsRegistered
);

Parameters

effects [out]

Type: CLSID*

When this method returns, contains an array of effects. NULL if no effects are retrieved.

effectCount

Type: UINT32

The capacity of the effects array.

effectsReturned [out]

Type: UINT32*

When this method returns, contains the number of effects copied into effects.

effectsRegistered [out, optional]

Type: UINT32*

When this method returns, contains the number of effects currently registered in the system.

Return value

Type: HRESULT

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

HRESULTDescription
S_OKNo error occurred.
E_OUTOFMEMORYDirect2D could not allocate sufficient memory to complete the call.
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)effectsRegistered is larger than effectCount.

 

Remarks

The set of class IDs will be atomically returned by the API. The set will not be interrupted by other threads registering or unregistering effects.

If effectsRegistered is larger than effectCount, the supplied array will still be filled to capacity with the current set of registered effects. This method returns the CLSIDs for all global effects and all effects registered to this factory.

Requirements

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

D2d1_1.h

Library

D2d1.lib

DLL

D2d1.dll

See also

ID2D1Factory1
ID2D1Factory1::RegisterEffect

 

 

Community Additions

Show:
© 2014 Microsoft