zephyr::raw

Function k_msgq_peek_at

source
pub unsafe extern "C" fn k_msgq_peek_at(
    msgq: *mut k_msgq,
    data: *mut c_void,
    idx: u32,
) -> i32
Expand description

@brief Peek/read a message from a message queue at the specified index

This routine reads a message from message queue at the specified index and leaves the message in the queue. k_msgq_peek_at(msgq, data, 0) is equivalent to k_msgq_peek(msgq, data)

@funcprops \isr_ok

@param msgq Address of the message queue. @param data Address of area to hold the message read from the queue. @param idx Message queue index at which to peek

@retval 0 Message read. @retval -ENOMSG Returned when the queue has no message at index.