Microsoft DirectX 8.1 (C++) |
IDirectInputDevice8::GetObjectInfo
Retrieves information about a device object, such as a button or axis.
HRESULT GetObjectInfo( LPDIDEVICEOBJECTINSTANCE pdidoi, DWORD dwObj, DWORD dwHow );
Parameters
- pdidoi
- Address of a DIDEVICEOBJECTINSTANCE structure to be filled with information about the object. The structure's dwSize member must be initialized before this method is called.
- dwObj
- Value that identifies the object whose information is to be retrieved. The value set for this parameter depends on the value specified in the dwHow parameter.
- dwHow
- Value that specifies how the dwObj parameter should be interpreted. This value can be one of the following:
Value Meaning DIPH_BYOFFSET The dwObj parameter is the offset into the current data format of the object whose information is being accessed. DIPH_BYID The dwObj parameter is the object type/instance identifier. This identifier is returned in the dwType member of the DIDEVICEOBJECTINSTANCE structure returned from a previous call to the IDirectInputDevice8::EnumObjects method. DIPH_BYUSAGE The dwObj parameter contains the HID Usage Page and Usage values of the object, combined by the DIMAKEUSAGEDWORD macro.
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:
DIERR_INVALIDPARAM |
DIERR_NOTINITIALIZED |
DIERR_OBJECTNOTFOUND |
E_POINTER |
Remarks
For compatibility with Microsoft® DirectX® 3, it is also valid to pass a DIDEVICEOBJECTINSTANCE_DX3 structure with the dwSize member initialized to sizeof(DIDEVICEOBJECTINSTANCE_DX3).
Requirements
Windows NT/2000/XP: Requires Windows® 2000.
Windows 98/Me: Requires Windows 98 or later. Available as a redistributable for Windows 98.
Header: Declared in Dinput.h.