IDirectInputDevice8::GetEffectInfo

Obtains information about an effect.

HRESULT GetEffectInfo(
  LPDIEFFECTINFO pdei,  
  REFGUID rguid         
);

Parameters

pdei

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

rguid

Reference to (C++) or address of (C) the 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:

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

Requirements

  Windows NT/2000/XP: Requires Windows® 2000.
  Windows 98/Me: Requires Windows 98 or later. Available as a redistributable for Windows 98.
  Header: Declared in Dinput.h.