GetQueueDepth method

Returns the total depth of all queues, based on a given filter.

Syntax
Visual Basic
Overloads Public Function GetQueueDepth( _
   ByVal filter As QueueDepthFilter _
) As Integer
C#
public int GetQueueDepth(
   QueueDepthFilter filter
);
Parameters
  • filter   A filter indicating incoming messages, outgoing messages, or all messages.

Return value

INTEGER - The number of messages that have not been received.

Remarks

The depth of the queue is the number of messages which have not been received (for example, using the QAManagerBase.GetMessage method), including uncommitted outgoing messages.

Exceptions
See also