HAL
HAL_IRDA_Receive() is only used within HAL.
 
Symbols
loading...
Files
loading...

HAL_IRDA_Receive() function

Receive an amount of data in blocking mode.

Syntax

HAL_StatusTypeDef HAL_IRDA_Receive(IRDA_HandleTypeDef *hirda,     uint8_t *pData,     uint16_t Size,     uint32_t Timeout);
Implemented in stm32f4xx_hal_irda.c:849

Arguments

hirda

Pointer to a IRDA_HandleTypeDef structure that contains the configuration information for the specified IRDA module.

pData

Pointer to data buffer (u8 or u16 data elements).

Size

Amount of data elements (u8 or u16) to be received.

Timeout

Specify timeout value

Return value

HAL status

Notes

When UART parity is not enabled (PCE = 0), and Word Length is configured to 9 bits (M1-M0 = 01), the received data is handled as a set of u16. In this case, Size must reflect the number of u16 available through pData.