Function | Description |
---|---|
xmsQueueBrowserClose | Close the queue browser. |
xmsQueueBrowserGetEnumeration | Get a list of the messages on the queue. |
xmsQueueBrowserGetMessageSelector | Get the message selector for the queue browser. |
xmsQueueBrowserGetQueue | Get the queue associated with the queue browser. |
xmsRC xmsQueueBrowserClose(xmsHQueueBrowser *browser, xmsHErrorBlock errorBlock);
If an application tries to close a queue browser that is already closed, the call is ignored.
xmsRC xmsQueueBrowserGetEnumeration(xmsHQueueBrowser browser, xmsHIterator *iterator, xmsHErrorBlock errorBlock);
Get a list of the messages on the queue.
The function returns an iterator that encapsulates a list of Message objects. The order of the Message objects in the list is the same as the order in which the messages would be retrieved from the queue. The application can then use the iterator to browse each message in turn.
The iterator is updated dynamically as messages are put on the queue and removed from the queue. Each time the application calls xmsIteratorGetNext() to browse the next message on the queue, the message returned reflects the current contents of the queue.
If an application calls this function more than once for a given queue browser, each call returns a new iterator. The application can therefore use more than one iterator to browse the messages on a queue and maintain multiple positions within the queue.
xmsRC xmsQueueBrowserGetMessageSelector(xmsHQueueBrowser browser, xmsCHAR *messageSelector, xmsINT length, xmsINT *actualLength, xmsHErrorBlock errorBlock);
Get the message selector for the queue browser.
For more information about how to use this function, see C functions that return a string by value.
xmsRC xmsQueueBrowserGetQueue(xmsHQueueBrowser browser, xmsHDest *queue, xmsHErrorBlock errorBlock);
Get the queue associated with the queue browser.