Syntax

Queue.Dequeue( removeElement, atFront, destinationPropObj, timeoutInSeconds, sequenceContextObj, processMsgs, waitRes)

Purpose

Dequeues data from the queue.

Parameters

removeElement As Boolean

[In] Pass True to remove the element from the queue. Pass False to retrieve the data for the element but leave it in the queue.

atFront As Boolean

[In] Pass True to retrieve the item at the front of the queue. Pass False to retrieve the item at the end.

destinationPropObj As Object

[In] Specifies the PropertyObject in which to store the queue element. You can pass a NULL reference when you do not want to store the data. The type of the destination PropertyObject must be compatible with the data the element stores. The Dequeue Behaviors for Data You Enqueue by Value and Dequeue Behaviors for Data You Enqueue by Reference tables illustrate the outcomes depending on the type of the data in the queue and the data type of the destination PropertyObject . In these tables, Simple Type refers to a number, string, Boolean, or array of any type, and Structured Type refers to an instance of a user-defined type where the root property is a container.

timeoutInSeconds As Double

[In] Specifies a timeout in seconds. Pass a negative number to specify you do not want a timeout.

sequenceContextObj As Object

[In] Specifies a sequence context when you call this method from within a step of an execution. You must use the sequence context of the sequence in which you are calling this method. Pass a NULL reference when you do not call this method from an execution. This method uses the sequence context to improve the behavior of the execution when it is blocked while waiting on this method.

processMsgs As Boolean

[In] Pass True to process Microsoft Windows messages while waiting. When you call this method from an execution, pass True for this parameter. Otherwise, pass False .

waitRes As WaitResult

[Out] Returns the status of the operation.

See Also

Dequeue Behaviors for Data You Enqueue by Reference

Dequeue Behaviors for Data You Enqueue by Value

PropertyObject

Sequence Context

WaitResult