Symbols

Files

Summary Syntax Arguments Examples References Call Tree Data Use

SourceVuSTM32 Libraries and SamplesCMSISosMessageQueueGet()

osMessageQueueGet() function

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

Syntax

Show:

Summary

Declaration

from cmsis_os2.h:719

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

Arguments

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.

Return value

status code that indicates the execution status of the function.

Examples

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

Libraries

cmsis_rtos_threadx

References

from 0/1 examples

Code

Location

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

cmsis_os2.h:719

Call Tree

from 0/1 examples

osMessageQueueGet() calls 1 function:

osMessageQueueGet()

__get_IPSR()

Data Use

from 0/1 examples

osMessageQueueGet() reads 4 variables:

osStatus_t::osOK

osStatus_t::osErrorTimeout

osStatus_t::osErrorResource

osStatus_t::osErrorParameter

osMessageQueueGet()

Class Tree

from 0/1 examples

All items filtered out

Override Tree

from 0/1 examples

All items filtered out

Implementations

from 0/1 examples

All items filtered out

Instances

from 0/1 examples

Lifecycle

from 0/1 examples

All items filtered out