IDirectInputDevice8::GetEffectInfo Method

Obtains information about an effect.

Syntax

HRESULT GetEffectInfo(      

    LPDIEFFECTINFO pdei,
    REFGUID rguid
);

Parameters

pdei

DIEFFECTINFO structure that receives information about the effect. The calling application must initialize the dwSize member of the structure before calling this method.

rguid

Reference to (C++) or address of (C) the globally unique identifier (GUID) identifying the effect for which information is being requested.

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_DEVICENOTREG	The device or device instance is not registered with Microsoft?DirectInput? This value is equal to the REGDB_E_CLASSNOTREG standard Component Object Model (COM) return value.
DIERR_INVALIDPARAM	An invalid parameter was passed to the returning function, or the object was not in a state that permitted the function to be called. This value is equal to the E_INVALIDARG standard COM return value.
DIERR_NOTINITIALIZED	The object has not been initialized.
E_POINTER	An invalid pointer, usually NULL, was passed as a parameter.

Remarks

Note  If this method is called on an non-Force Feedback device, E_POINTER will be returned.