DirectInputDevice8.GetDeviceObjectsEnum

Enumerates the input and output objects available on a device.

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

Parts

object

Resolves to a DirectInputDevice8 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 that represents the collection of enumerated devices.

Error Codes

If the method fails, an error is raised and Err.Number is 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.

Applications should not rely on enumeration to determine whether certain keyboard keys or indicator lights are present, as these objects might be enumerated even though they are not present. Although the basic set of available objects can be determined from the device subtype, there is no reliable way of determining whether extra objects such as the menu key are available.