NXC  Version 1.2.1 r5
 All Data Structures Files Functions Variables Groups Pages
char ReceiveMessage ( byte  queue,
bool  clear,
string &  msg 
)
inline

Read a message from a queue/mailbox.

Read a message from a mailbox and optionally remove it. If the local mailbox is empty and this NXT is the master then it attempts to poll one of its slave NXTs for a message from the response mailbox that corresponds to the specified local mailbox number.

Parameters
queueThe mailbox number. See Mailbox constants.
clearA flag indicating whether to remove the message from the mailbox after it has been read.
msgThe message that is read from the mailbox.
Returns
A char value indicating whether the function call succeeded or not.