IDirectInputDevice8::SetDataFormat

Sets the data format for the Microsoft® DirectInput® device.

HRESULT SetDataFormat(
  LPCDIDATAFORMAT lpdf  
);

Parameters

lpdf

Address of a structure that describes the format of the data that the DirectInputDevice should return. An application can define its own DIDATAFORMAT structure or use one of the following predefined global variables:

• c_dfDIKeyboard
• c_dfDIMouse
• c_dfDIMouse2
• c_dfDIJoystick
• c_dfDIJoystick2

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:

Remarks

The data format must be set before the device can be acquired by using the IDirectInputDevice8::Acquire method. It is necessary to set the data format only once. The data format cannot be changed while the device is acquired.

If the application is using action mapping, the data format is set instead by the call to IDirectInputDevice8::SetActionMap.

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.

See Also

IDirectInputDevice8::GetDeviceState