Syntax

Queue.Enqueue( atFront, fqOption, newElementPropObj, byRef, timeoutInSeconds, sequenceContextObj, processMsgs, waitRes, enqueueRes)

Purpose

Enqueues data into the queue.

Parameters

atFront As Boolean

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

fqOption As FullQueueOption

[In] Specifies what to do when the queue is full. Refer to the FullQueueOption enumeration for more information about values for this parameter.

newElementPropObj As Object

[In] Specifies a PropertyObject that is the item or contains the value of the item to insert into the queue. You can use data of any type, including a number, string, Boolean, object reference, structured type (container), or arrays of these types. When you dequeue the element you must specify a destination PropertyObject with the appropriate type.

byRef As Boolean

[In] When you pass False , the queue stores a copy of the data you enqueue. When you pass True , the Enqueue operation stores an object reference to the data value.

timeoutInSeconds As Double

[In] Specifies the timeout, in seconds. Pass a negative number to specify that 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 Enqueue operation.

enqueueRes As EnqueueResult

[Out] Returns the result of the Enqueue operation .

See Also

EnqueueResult

FullQueueOption

PropertyObject

Sequence Context

WaitResult