IDirectInputDevice7::GetEffectInfo

The IDirectInputDevice7::GetEffectInfo method 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

Identifier of 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:

Remarks

In C++, the rguid parameter must be passed by reference; in C, which does not have pass-by-reference, it must be passed by address. The following is an example of a C++ call:

lpdev2->GetEffectInfo(&dei, GUID_Effect);

The following shows the same call in C:

lpdev2->lpVtbl->GetEffectInfo(lpdev2, &dei, &GUID_Effect);

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Requires Windows 95 or later. Available as a redistributable for Windows 95.
  Header: Declared in dinput.h.
  Import Library: Use dinput.lib.