Queue.GetInfo
- Updated2025-07-21
- 1 minute(s) read
Queue.GetInfo
Syntax
Queue.GetInfo( sequenceContextObj, destQueueElementsArrayPropObj, numThreadsWaitingToEnqueue, numThreadsWaitingToDequeue, sizeLimit, numElements)
Purpose
Obtains information about the queue and optionally retrieves all its elements.
Parameters
sequenceContextObj As Object
[In] Specifies a sequence context . You can pass NULL for this parameter, but to retrieve the elements, you must pass a valid sequence context.
destQueueElementsArrayPropObj As Object
[In] Specifies an array PropertyObject in which to store the elements of the queue. All queue elements must be of the same data type as the array you specify and no queue element can be an array. You can pass NULL for this parameter.
numThreadsWaitingToEnqueue As Long
[Out] Returns the number of threads waiting to perform an Enqueue operation. You can pass NULL for this parameter.
numThreadsWaitingToDequeue As Long
[Out] Returns the number of threads waiting to perform a Dequeue operation. You can pass NULL for this parameter.
sizeLimit As Long
[Out] Returns the size limit of the queue. A value less than or equal to zero indicates that the queue does not have a maximum size. You can pass NULL for this parameter.
numElements As Long
[Out] Returns the number of elements in the queue. You can pass NULL for this parameter.