IDirectInputDevice2::EnumCreatedEffectObjects

The IDirectInputDevice2::EnumCreatedEffectObjects method enumerates all of the currently created effects for this device. Effects created by IDirectInputDevice2::CreateEffect are enumerated.

HRESULT EnumCreatedEffectObjects(
  LPDIENUMCREATEDEFFECTOBJECTSCALLBACK lpCallback,  
  LPVOID pvRef,                                     
  DWORD fl                                          
);
 

Parameters

lpCallback

Address of an application-defined callback function. DirectInput provides the prototype function DIEnumCreatedEffectObjectsProc.

pvRef

Reference data (context) for callback.

fl

No flags are currently defined. This parameter must be 0.

Return Values

If the method succeeds, the return value is DI_OK.

If the method fails, the return value may be one of the following error values:

Remarks

The results will be unpredictable if you create or destroy an effect while an enumeration is in progress. However, the callback function can safely release the effect passed to it.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Use Windows 95 or later. Available as a redistributable for Windows 95.
  Windows CE: Unsupported.
  Header: Declared in dinput.h.
  Import Library: Use dinput.lib.