DeviceObjectInstance Structure (Microsoft.DirectX.DirectInput)

Describes a device object instance. This structure is used with the Inputdevice9Enumobjects method to provide the Dienumdeviceobjectscallback callback function with information about a particular object associated with a device, such as an axis or button. It is also used with the Inputdevice9Getobjectinfo method to retrieve information about a device object.

Definition

Visual Basic	Public Structure DeviceObjectInstance
C#	public struct DeviceObjectInstance
C++	public value class DeviceObjectInstance sealed
JScript	In JScript, you can use structures, but you cannot define your own.

Members Table

The following table lists the members exposed by the object.

Methods

Method	Description
DeviceObjectInstance	Initializes a new instance of the object.
ToString	Obtains a string representation of the current instance.

Properties

Property	Description
CollectionNumber	The Human Interface Device (TermHid) link collection to which the object belongs.
DesignatorIndex	An index that refers to a designator in the HID physical descriptor. This number can be passed to functions in the HID parsing library (Hidpi.h) to obtain additional information about the device object.
Dimension	A Human Interface Device (HID) code for the dimensional units in which the object's value is reported, if known, or 0 if not known.
Exponent	The exponent to associate with the dimension, if known. Dimensional units are always integral, so an exponent might be needed to convert them to nonintegral types.
Flags	Flags describing other attributes of the data format. This value can be one of the following:
ForceResolution	The force resolution of the actuator associated with this object. The returned value represents the number of gradations, or subdivisions, of the maximum force that can be expressed by the force-feedback system from 0 (no force) to maximum force.
MaxForce	The magnitude of the maximum force that can be created by the actuator associated with this object. Force is expressed in newtons and measured in relation to where the hand would be during normal operation of the device.
Name	Name of the object, for example, 'X-Axis' or 'Right Shift.'
ObjectId	An index that refers to a designator in the HID physical descriptor. This number can be passed to functions in the HID parsing library (Hidpi.h) to obtain additional information about the device object.
ObjectType	Unique identifier that indicates the object type. This member is optional. If present, it can be one of the following values:
Offset	Offset in the native data format of the device. The native data format corresponds to the raw device data. The DwOfs member does not correspond to the device constant, such as DIJOFS_BUTTON0, for this object.
ReportId	Reserved.
Usage	The HID usage associated with the object, if known. HIDs always report a usage. Non-HIDs can optionally report a usage; if they do not, the value of this member is 0.
UsagePage	The Human Interface Device (HID) usage page associated with the object, if known. HIDs always report a usage page. Non-HID devices can optionally report a usage page; if they do not, the value of this member is 0.

Structure Information

Namespace	Microsoft.DirectX.DirectInput
Assembly	Microsoft.DirectX.DirectInput (microsoft.directx.directinput.dll)
Strong Name	Microsoft.DirectX.DirectInput,  Version=1.0.900.0,  Culture=neutral,  PublicKeyToken=d3231b57b74a1492