GetQueueDepth method

Returns the depth of a queue, based on a given filter, including uncommitted outgoing messages.

Syntax
Visual Basic
Overloads Public Function GetQueueDepth( _
   ByVal queue As String, _
   ByVal filter As QueueDepthFilter _
) As Integer
C#
public int GetQueueDepth(
   string  address,
   QueueDepthFilter filter
);
Parameters
  • queue   The queue name.

  • 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).

Exceptions
See also