<Stack variable>.Pop (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

<Stack variable>.Pop (Function)

In french: <Variable Pile>.Dépile

Pops an element from a stack. The element found at the top of stack is deleted 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 Android applications.

This function is now available in Android Widget mode.

This function is now available for Java applications.

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 Android applications.

This function is now available in Android Widget mode.

This function is now available for Java applications.

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 Android applications.

This function is now available in Android Widget mode.

This function is now available for Java applications.

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

Example

MyStack is Stack of int

// Push the values 1, 2 and 3
MyStack.Push(1)
MyStack.Push(2)
MyStack.Push(3)

// Display the trace: 3, 2, 1
x is int
WHILE MyStack.Pop(x) = True
Trace(x)
END

Syntax

Retrieving the element at the top of stack Hide the details

<Result> = <Stack>.Pop([<Element>])

<Result>: Boolean

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

<Stack>: Stack

Name of the Stack variable to use.

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

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

Retrieving the element at the top of stack (multithread syntax) Hide the details

<Result> = <Stack>.Pop([<Element> [, <Options> [, <Wait>]]])

<Result>: Boolean

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

<Stack>: Stack

Name of the Stack variable to use.

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

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

<Options>: Optional Integer constant

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

<Wait>: Optional integer

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 the stack is empty, <Stack variable>.Pop waits for an element to be added into the stack. The maximum timeout can be specified by the <Timeout> parameter.

The function returns True if an element was popped, False if the timeout is exceeded or if AdditionCompleted becomes True.

NbPendingThread returns the number of pending threads.

The assignment of AdditionCompleted to True provokes the end of the timeout for all the pending threads. In this case, <Stack variable>.Pop returns False.

Component: wd260vm.dll