<Queue variable>.Dequeue (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Operating mode for a multithread management

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Queue variable>.Dequeue (Function)

In french: <Variable File>.Défile

Dequeues an element from a queue. The element is deleted from the queue and returned in the specified variable.

Versions 18 and later

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

New in version 18

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

This function is now available in Windows Store apps mode.

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Apple Watch mode.

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Apple Watch mode.

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available in Universal Windows 10 App mode.

This function is now available in Apple Watch mode.

This function is now available for Java applications.

This function is now available for Android applications.

This function is now available in Android Widget mode.

This function is now available in Universal Windows 10 App mode.

Example

MyQueue is Queue of int

// Enqueues the values 1, 2 and 3
MyQueue.Enqueue(1)
MyQueue.Enqueue(2)
MyQueue.Enqueue(3)

// Display the trace: 1, 2, 3
x is int
WHILE MyQueue.Dequeue(x)
Trace(x)
END

Syntax

Retrieving the element at the beginning of queue Hide the details

<Result> = <Queue>.Dequeue([<Element>])

<Result>: Boolean

True if the element was unstacked,
False if the queue is empty.

<Queue>: Queue

Name of the Queue variable to use.

<Element>: Type of elements handled by the queue, optional parameter

Name of variable into which the value of dequeued element is returned. If this parameter is not specified, the element is dequeued but its value is not retrieved.

Retrieving the element at the beginning of queue (multithread syntax) Hide the details

<Result> = <Queue>.Dequeue([<Element> [, <Options> [, <Wait>]]])

<Result>: Boolean

True if the element was unstacked,
False if the timeout is exceeded (<Timeout> parameter) or if AdditionCompleted becomes True.

<Queue>: Queue

Name of the Queue variable to use.

<Element>: Type of elements handled by the queue, optional parameter

Name of variable into which the value of dequeued element is returned. If this parameter is not specified, the element is dequeued but its value is not retrieved.

<Options>: Optional Integer constant

Option for managing the queue:
WaitIfEmpty Waits for an element to be added into the queue by another thread.

<Wait>: Optional integer or optional Duration

Maximum timeout expressed in hundredths of a second. This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
Versions 23 and later
the duration in text format (e.g., 1 s or 10 ms).
New in version 23
the duration in text format (e.g., 1 s or 10 ms).
the duration in text format (e.g., 1 s or 10 ms).
This parameter corresponds to the Infinite constant by default (no maximum timeout).

Remarks

Operating mode for a multithread management

If an element is found in the queue, it is deleted from the queue and returned by the <Element> parameter by reference.

If the queue is empty, <Queue variable>.Dequeue waits for an element to be added into the queue. The maximum timeout can be specified by the <Timeout> parameter.

The function returns True if an element was dequeued, False if the time-out is exceeded or if AdditionCompleted becomes True.

NbPendingThread returns the number of pending threads.

Assigning Property AdditionCompleted to True causes all pending threads to stop waiting. In this case, <Queue variable>.Dequeue returns False.

Component: wd260vm.dll