IDirectInputDevice8::EnumCreatedEffectObjects Method

Enumerates all the currently created effects for this device. Effects created by IDirectInputDevice8::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 DIEnumCreatedEffectObjectsCallback.
pvRef
Reference data (context) for callback.
fl
No flags are currently defined. This parameter must be 0.

Return Value

If the method succeeds, the return value is DI_OK. If the method fails, the return value can be one of the following error values: DIERR_INVALIDPARAM, DIERR_NOTINITIALIZED.

The results are 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.

Header: Declared in dinput.h.

Community Additions

ADD
Show:
© 2014 Microsoft