Equinox Online Help - Language Reference - A to Z
RetrieveMessage |
|
|---|---|
| Applies to |       |
| Syntax | RetrieveMessage MessageItem, [CategoryExpression] |
| Action | [Statement] Retrieves a message from the server message queue |
| Scope | Usable anywhere. |
| Notes | This statement retrieves the next message available to the current user, from the server message queue. The first argument, MessageItem, should be the name of character field, variable or workarea into which the message is read. Note that if the message is bigger than the maximum size of this item, the end of the message is lost. You may use the second argument, CategoryExpression, to specify a particular message category. The next message in this category will be returned. Note that if there are no available messages in the queue, an error number is stored in the system workarea SysError. |
| Category | Messages |
| See Also | DeleteAllMessages, DeleteMessage, DisplayMessage, MessageID, MessageMaxLength, MessageQueueSize, MessageRetrieved, MessagesWaiting, QueueMessage |
| Example | The following example checks if there are any messages queued for the current user and if so retrieves the next one into the workarea NextMessage. If MessagesWaiting > 0 Then RetrieveMessage NextMessage |