|Microsoft DirectX 9.0|
Retrieves immediate data from the device.
DWORD cbData, LPVOID lpvData );
- Size of the buffer in the lpvData parameter, in bytes.
- Address of a structure that receives the current state of the device. The format of the data is established by a prior call to the IDirectInputDevice8::SetDataFormat method.
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_INPUTLOST Access to the input device has been lost. It must be reacquired. DIERR_INVALIDPARAM An invalid parameter was passed to the returning function, or the object was not in a state that permitted the function to be called. This value is equal to the E_INVALIDARG standard Component Object Model (COM) return value. DIERR_NOTACQUIRED The operation cannot be performed unless the device is acquired. DIERR_NOTINITIALIZED The object has not been initialized. E_PENDING Data is not yet available.
Before device data can be obtained, set the cooperative level by using the IDirectInputDevice8::SetCooperativeLevel method, then set the data format by using IDirectInputDevice8::SetDataFormat, and acquire the device by using the IDirectInputDevice8::Acquire method.
The five predefined data formats require corresponding device state structures according to the following table:
Data format State structure c_dfDIMouse DIMOUSESTATE c_dfDIMouse2 DIMOUSESTATE2 c_dfDIKeyboard array of 256 bytes c_dfDIJoystick DIJOYSTATE c_dfDIJoystick2 DIJOYSTATE2
For example, if you passed the c_dfDIMouse format to the IDirectInputDevice8::SetDataFormat method, you must pass a DIMOUSESTATE structure to the IDirectInputDevice8::GetDeviceState method.