osMessageQueueGet() function

Get a Message from a Queue or timeout if Queue is empty.

Syntax

Show:

Summary

Declaration

osStatus_t osMessageQueueGet (osMessageQueueId_t mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t timeout);

Argument

Description

mq_id

message queue ID obtained by osMessageQueueNew.

msg_ptr

pointer to buffer for message to get from a queue.

msg_prio

pointer to buffer for message priority or NULL.

timeout

CMSIS_RTOS_TimeOutValue or 0 in case of no time-out.

status code that indicates the execution status of the function.

osMessageQueueGet() is referenced by 1 libraries and example projects:

from examples