cancel | |||||||
Type | command | ||||||
Dictionary | LCS | ||||||
Library | LiveCode Script | ||||||
Syntax |
| ||||||
Summary | Removes a message that was queued with the send command and is waiting to be sent. | ||||||
Introduced | 1.0 | ||||||
OS | mac, windows, linux, ios, android | ||||||
Platforms | desktop, server | ||||||
Parameters |
| ||||||
Example |
| ||||||
Related | Keyword: item Glossary: command, custom property, global, loop, message, script local variable, variable Command: send Object: card, stack Function: flushEvents, pendingMessages, result Control Structure: function, repeat | ||||||
Description | Use the cancel command to get rid of messages that were set up but are no longer required. 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 messageQueueID in a script local variable, a global variable, or a custom property at the time the message is sent. Then you can cancel all those messages in a repeat loop :
| ||||||
Tags | messages |