Symbols

loading...

Files

loading...

Summary Syntax Arguments Related References

SourceVuSTM32 Libraries and SamplesFreeRTOSosMailGet()

osMailGet() function

Get a mail from a queue

Syntax

Show:

Summary

Declaration

Definition

from cmsis_os.h:873

osEvent osMailGet (osMailQId queue_id, uint32_t millisec);

Implemented in cmsis_os.c:1290

Arguments

Argument

Description

queue_id

mail queue ID obtained with osMailCreate.

millisec

timeout value or 0 in case of no time-out

Return value

event that contains mail information or error code.

Notes

MUST REMAIN UNCHANGED: \b osMailGet shall be consistent in every CMSIS-RTOS.

Examples

osMailGet() is referenced by 2 libraries and example projects:

References

from examples