IDirectInputDevice8::GetEffectInfo

Obtains information about an effect.

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 Values

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, DIERR_INVALIDPARAM, DIERR_NOTINITIALIZED, E_POINTER.

Remarks

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

Requirements

Header: Declared in Dinput.h.