tibemsAdmin_GetQueues

Function

Purpose

Get the queues that match the given pattern and the given permanence type.

C Declaration

tibems_status tibemsAdmin_GetQueues(
    tibemsAdmin admin,
    tibemsCollection* collection,
    const char* pattern,
    tibems_int permType);

COBOL Call

CALL "tibemsAdmin_GetQueues"
 USING BY VALUE admin,
       BY REFERENCE collection,
       BY REFERENCE pattern,
       BY VALUE permType,
       RETURNING tibems-status
END-CALL.
Note: collection has usage pointer.

Parameters

Parameter Description
admin Get information about queues using this administration connection.
collection The function stores the returned queue data in the location specified here, as a collection of tibemsQueueInfo objects.
pattern The queue name pattern that must be matched.

The pattern may contain the wildcards * and >. A pattern of > or NULL will return all queues that exist in the server.

For more information, see Wildcards in Queues in the TIBCO Enterprise Message Service User’s Guide.

permType The permanence type of the queue must match the type given here. Possible permanence types are:
  • TIBEMS_DEST_GET_ALL – Return all queues that match the pattern.
  • TIBEMS_DEST_GET_STATIC – Return only static queues that match the pattern.
  • TIBEMS_DEST_GET_DYNAMIC – Return only dynamic queues that match the pattern.
  • TIBEMS_DEST_GET_NOTEMP – Do not return any temporary queues.

A NULL value matches all queues.

Status Codes

Status Code Description
TIBEMS_TIMEOUT The administrative query timed out while waiting for a server response.
TIBEMS_NOT_FOUND No queues found matching the specified pattern and performance type.

See Also

tibemsQueueInfo