CP2114 datasheet(11/54 Pages) SILABS

11 / 54 page

AN433

Rev. 0.5

2.13. HidUart_Read

Description:

Reads the available number of bytes into the supplied buffer and returns the number of bytes read

which can be less than the number of bytes requested. This function returns synchronously after

reading the requested number of bytes or after the timeout duration has elapsed. Read and write

timeouts can be set using HidUart_SetTimeouts() described in "2.17. HidUart_SetTimeouts" on

page 13.

Prototype:

HID_UART_STATUS HidUart_Read (HID_UART_DEVICE device, BYTE* buffer,

DWORD numBytesToRead, DWORD* numBytesRead)

Parameters:1.

device—Device object pointer as returned by HidUart_Open().

buffer—Address of a buffer to be filled with read data.

numBytesToRead—Number of bytes to read from the device into the buffer (1–32768). This

value must be less than or equal to the size of buffer.

numBytesRead—Returns the number of bytes actually read into the buffer on completion.

Return Value: HID_UART_STATUS

HID_UART_SUCCESS

HID_UART_READ_ERROR

HID_UART_INVALID_PARAMETER

HID_UART_INVALID_DEVICE_OBJECT

HID_UART_READ_TIMED_OUT

HID_UART_INVALID_REQUEST_LENGTH

Remarks:

HidUart_Read() returns HID_UART_READ_TIMED_OUT if the number of bytes read is less than

the number of bytes requested. This will only occur after the read timeout has elapsed. If the

number of bytes read matches the number of bytes requested, this function will return

HID_UART_SUCCESS.

CP2114 Datasheet(PDF) 11 Page - Silicon Laboratories