pMessageQueue
pMessageQueue
Manage the Message Queue.
Syntax
pMessageQueue ( out vlStatus,
in vlOperation,
inout vlProcessId,
in vlWindowName )
Parameters
| vlStatus | The returned status from pMessageQueue. |
| vlOperation | The operation to be performed on the queue. |
| vlProcessId | The process id. |
| vlWindowName | The window name. |
Comments
The pMessageQueue command is the primary manager of the Message Queue. Usually, pPostActionQueue and pActionQueue are called to manage the Message Queue as they provide a somewhat easier to use interface. They call pMessageQueue to actually do messaging operations. pMessageQueue receives new queue entries and returns queue entries using the form vMessage. On exit, vlStatus is blank if no errors occur. Otherwise it is set to “ERROR”. The supported operations are:
| VlOperation | Meaning |
| FINI | Shut down the Message Queue. |
| GET | Gets the next entry from the queue and update vMessage and vlProcessId. |
| GETBYPROCESSID | Gets the next action on the queue for the process id specified by vlProcessId. |
| GETBYWINDOW | Gets the next action on the queue for the window specified in vlWindowName. |
| INIT | Initialize the Message Queue. |
| LIST | Produce a report on Message Queue entries and send the output to the STDERR document. |
| PEEK | Peek at next queue entry but leave it on the queue. |
| PEEKBYPROCESSID | Peek at next queue entry for specified process id |
| PEEKBYWINDOW | Peek at next queue entry for specified window. |
| PEEKFIRST | Peek at first entry in queue. |
| PEEKLAST | Peek at first entry in queue. |
| PEEKNEXT | Peek at next entry. Can be called repeatedly to peek at all entries. vlStatus is set to “ENDOFLIST” after all entries have been examined. |
| PEEKPREVIOUS | Peek at previous entry. Can be called repeatedly to peek at all entries. vlStatus is set to “ENDOFLIST” after all entries have been examined. |
| POST | Place a queue entry at the end of the queue. |
| PURGEALL | Clear all entries from the Message Queue |
| TEST | Open the Message Queue display window and visually manage queue entries. |