Removes a message that was queued with the send command and is waiting to be sent.
Syntax:
cancel messageQueueID
Examples:
cancel 2298
cancel item 1 of last line of the pendingMessages
Use the cancel command to get rid of messages that were set up but are no longer required.
The messageQueueID is the ID number of the message.
The ID number of the message is returned by the send command that sent the message. This number is also the first item of the line corresponding to the message in the pendingMessages function.
All pending messages are automatically canceled when the application quits.
It is common to need to cancel a number of messages when leaving a card or stack, if the messages only pertain to that card or stack. For example, you might have queued a number of messages that create an animated display on the current card, and need to cancel them when the user goes to another card. The best solution in a case like this is to place each message ID number in a global variable or custom property at the time the message is sent. Then you can cancel all those messages in a repeat loop:
global myPendingMessages -- you've stored the message IDs here
on closeCard
repeat for each line thisMessageID in myPendingMessages
cancel thisMessageID
end repeat
end closeCard
See Also: pendingMessages Function, flushEvents Function, send Command