UART_GET_BYTE callback function (uart.h)

Reads a data byte from the UART device.

Syntax

UART_GET_BYTE UartGetByte;

UART_STATUS UartGetByte(
  [_Inout_] PCPPORT Port,
  [_Out_]   PUCHAR Byte
)
{...}

Parameters

[_Inout_] Port

A pointer to a _CPPORT structure that contains the address of the port object that describes the UART hardware.

[_Out_] Byte

A pointer to a variable that contains received byte.

Return value

Returns UART_STATUS-type value that indicates success or failure of the operation.

Remarks

Register your implementation of this callback function by setting the appropriate member of UART_HARDWARE_DRIVER.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1803
Header uart.h

See also

UART_HARDWARE_DRIVER

_CPPORT

UART_STATUS

uart.h