osMessageQueueReset() function

Reset a Message Queue to initial empty state.

Syntax

Show:

Summary

Declaration

from cmsis_os2.h:744

osStatus_t osMessageQueueReset (osMessageQueueId_t mq_id);

Arguments

Argument

Description

mq_id

message queue ID obtained by osMessageQueueNew.

Return value

status code that indicates the execution status of the function.

Examples

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

Libraries

cmsis_rtos_threadx

References

from 0/1 examples

Code

Location

osStatus_t osMessageQueueReset (osMessageQueueId_t mq_id);

cmsis_os2.h:744

Call Tree

from 0/1 examples

osMessageQueueReset() calls 1 function:

osMessageQueueReset()

__get_IPSR()

Data Use

from 0/1 examples

osMessageQueueReset() reads 4 variables:

osStatus_t::osOK

osStatus_t::osErrorResource

osStatus_t::osErrorParameter

osStatus_t::osErrorISR

osMessageQueueReset()

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