Platform SDK: DirectX

DirectInputDevice.GetEffectsEnum

The DirectInputDevice.GetEffectsEnum method enumerates force-feedback effects supported by the device, including standard effects as well as effects designed by the device manufacturer.

object.GetEffectsEnum( _
  effType As CONST_DIEFTFLAGS) As DirectInputEnumEffects

Parameters

object
Object expression that resolves to a DirectInputDevice object.
effType
One of the following flags from the CONST_DIEFTFLAGS enumeration specifying the type of effect to be enumerated:

DIEFT_ALL
DIEFT_CONDITION
DIEFT_CONSTANTFORCE
DIEFT_CUSTOMFORCE
DIEFT_HARDWARE
DIEFT_PERIODIC
DIEFT_RAMPFORCE

Return Values

The method returns a DirectInputEnumEffects object whose methods can be used to retrieve information about the effects.

Error Codes

If the method fails, an error is raised and Err.Number will be set.