Platform SDK: DirectX

DirectInputDevice.GetDeviceObjectsEnum

The DirectInputDevice.GetDeviceObjectsEnum method returns a DirectInputEnumDeviceObjects object which is used to enumerate the objects available on a device. A device object is typically an axis or a button.

object.GetDeviceObjectsEnum( _ 
  flags As CONST_DIDFTFLAGS) _ 
  As DirectInputEnumDeviceObjects

Parameters

object
Object expression that resolves to a DirectInputDevice object.
flags
Flags specifying the type of object to be enumerated. Can be one or more of the members of the CONST_DIDFTFLAGS enumeration.

Return Values

If the method succeeds, the return value is a DirectInputEnumDeviceObjects object.

Error Codes

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

Remarks

The DIDFT_FFACTUATOR and DIDFT_FFEFFECTTRIGGER flags restrict enumeration to objects that meet all the criteria defined by the included flags. For all the other flags, an object is enumerated if it meets the criterion defined by any included flag in this category. For example, (DIDFT_FFACTUATOR Or DIDFT_FFEFFECTTRIGGER) restricts enumeration to force-feedback trigger objects, and (DIDFT_FFEFFECTTRIGGER Or DIDFT_TGLBUTTON Or DIDFT_PSHBUTTON) restricts enumeration to buttons of any kind that can be used as effect triggers.