Jump to main content

##

# 2.8.55 CANx_MailboxIsReady Function

## C

    bool CANx_MailboxIsReady(CAN_MAILBOX_NUM mailbox) // x - Instance of the CAN peripheral

## Summary

Returns true if Mailbox is ready otherwise false.

## Precondition

CANx_Initialize must have been called for the associated CAN instance.

## Parameters

Param | Description
--- | ---
mailbox | Mailbox number

## Returns

true - Mailbox is ready and Mailbox data registers can be read/written.

false - Mailbox is not ready and Mailbox data registers can not be read/written.

## Example

    if (CAN0_MailboxIsReady(CAN_MAILBOX_0))
    {
        //Mailbox is ready and Mailbox data registers can be read/written.
    }

## Remarks

None.