[TIBCO.EMS .NET Admin client library 8.1 documentation]

Get the info for the queues that match the given pattern and the given permanence type, (that can be either of the RequestDestInfo types) that is an indication to return queues only of specified types.

Namespace:  TIBCO.EMS.ADMIN
Assembly:  TIBCO.EMS.ADMIN (in TIBCO.EMS.ADMIN.dll)

Syntax

public QueueInfo[] GetQueues(
	string pattern,
	RequestDestInfo permanenceType,
	int cursorPosition,
	int cursorSize
)
Public Function GetQueues ( _
	pattern As String, _
	permanenceType As RequestDestInfo, _
	cursorPosition As Integer, _
	cursorSize As Integer _
) As QueueInfo()
public:
array<QueueInfo^>^ GetQueues(
	String^ pattern, 
	RequestDestInfo permanenceType, 
	int cursorPosition, 
	int cursorSize
)

Parameters

pattern
Type: System..::.String
The pattern that must be matched
permanenceType
Type: TIBCO.EMS.ADMIN..::.RequestDestInfo
The permanenceType can be either RequestDestInfo.DestGetNoTemp, RequestDestInfo.DestGetStatic, RequestDestInfo.DestGetDynamic RequestDestInfo.DestGetAll.
cursorPosition
Type: System..::.Int32
The cursorPosition can be Admin.DEST_CURSOR_FIRST, Admin.DEST_CURSOR_NEXT, Admin.DEST_CURSOR_LAST
cursorSize
Type: System..::.Int32
The cursorSize must be greater than zero. Note that the operation may return less than the requested size.

Return Value

The QueueInfos that match the pattern and permanenceType. Returns null when cursor is complete.

Remarks

The pattern may contain the wildcards "*" and ">". See the TIBCO EMS documentation for how wildcards work in queue names. A pattern of "", ">", or null will return all the queues if permanenceType is DestGetALL One can start, continue or complete a cursored scan of queues.

Exceptions

ExceptionCondition
TIBCO.EMS.ADMIN..::.AdminExceptionif not authorized or an error occurred.
System..::.ArgumentExceptionif permanenceType is invalid

See Also