xQueuePeekFromISR() is only used within FreeRTOS.
 
Symbols
loading...
Files
loading...

xQueuePeekFromISR() function

A version of xQueuePeek() that can be called from an interrupt service routine (ISR). Receive an item from a queue without removing the item from the queue. The item is received by copy so a buffer of adequate size must be provided. The number of bytes copied into the buffer was defined when the queue was created. Successfully received items remain on the queue so will be returned again by the next call, or a call to xQueueReceive().

Syntax

BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue,     void * const pvBuffer ) PRIVILEGED_FUNCTION;
Implemented in queue.c:1876

Arguments

xQueue

The handle to the queue from which the item is to be received.

pvBuffer

Pointer to the buffer into which the received item will be copied.

Return value

pdTRUE if an item was successfully received from the queue, otherwise pdFALSE.

References

LocationText
queue.c:1876
BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue, void * const pvBuffer )
queue.h:777
BaseType_t xQueuePeekFromISR( QueueHandle_t xQueue, void * const pvBuffer ) PRIVILEGED_FUNCTION;

Call Tree

Functions called by xQueuePeekFromISR()
xQueuePeekFromISR()
Data read by xQueuePeekFromISR()
Data written by xQueuePeekFromISR()
xQueuePeekFromISR()::xReturn
xQueuePeekFromISR()::uxSavedInterruptStatus
xQueuePeekFromISR()::pcOriginalReadPosition
xQueuePeekFromISR()::pxQueue
all items filtered out
xQueuePeekFromISR()
xQueuePeekFromISR()::xReturn
xQueuePeekFromISR()::uxSavedInterruptStatus
xQueuePeekFromISR()::pcOriginalReadPosition
all items filtered out
Type of xQueuePeekFromISR()
xQueuePeekFromISR()
int8_t
all items filtered out