ThreadWait (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ThreadWait (Function)

In french: ThreadAttend

Waits for the end of the execution of the specified thread. A maximum timeout can be specified.

Reminder: A thread is a process run in parallel with the current application (main thread). This allows you to run a task in the background (e.g. backup, etc.).

Example

ThreadExecute("Thread1", threadNormal, ThreadProcedure)
...
ThreadWait("Thread1", 300)

Versions 25 and later

// Build a thread
t is Thread(Proc, ("First parameter", 2))
// Trigger the execution of the thread
ThreadExecute(t)
...
ThreadWait(t, 300)

New in version 25

// Build a thread
t is Thread(Proc, ("First parameter", 2))
// Trigger the execution of the thread
ThreadExecute(t)
...
ThreadWait(t, 300)

Syntax

Waiting for the end of the thread execution (use thread name) Hide the details

<Result> = ThreadWait(<Thread name> [, <Maximum timeout>])

<Result>: Boolean

True if the thread was stopped or if the thread does not exist,
False if the thread is not stopped (the maximum duration is exceeded).

<Thread name>: Character string

Name of thread that must reach the end of its execution. This name is given when running the thread (ThreadExecute).

<Maximum timeout>: Optional integer, optional duration or optional constant

Maximum timeout in hundredths of a second.
If the thread is not stopped at the end of specified duration, <Result> is set to False.
If this parameter is not specified or corresponds to the Infinite constant, the wait is infinite.
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 a readable format (e.g., 1 s or 10 ms).
New in version 23
the duration in a readable format (e.g., 1 s or 10 ms).
the duration in a readable format (e.g., 1 s or 10 ms).

Versions 25 and later

Wait for the end of the thread execution (use of a Thread variable) Hide the details

<Result> = ThreadWait(<Thread to wait for> [, <Maximum timeout>])

<Result>: Boolean

True if the thread was stopped or if the thread does not exist,
False if the thread is not stopped (the maximum duration is exceeded).

<Thread to wait for>: Thread variable

Name of the Thread variable that corresponds to the thread that must reach the end of its execution.

<Maximum timeout>: Optional integer, optional duration or optional constant

Maximum timeout in hundredths of a second.
If the thread is not stopped at the end of specified duration, <Result> is set to False.
If this parameter is not specified or corresponds to the Infinite constant, the wait is infinite.
This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
the duration in a readable format (e.g., 1 s or 10 ms).

New in version 25

Wait for the end of the thread execution (use of a Thread variable) Hide the details

<Result> = ThreadWait(<Thread to wait for> [, <Maximum timeout>])

<Result>: Boolean

True if the thread was stopped or if the thread does not exist,
False if the thread is not stopped (the maximum duration is exceeded).

<Thread to wait for>: Thread variable

Name of the Thread variable that corresponds to the thread that must reach the end of its execution.

<Maximum timeout>: Optional integer, optional duration or optional constant

Maximum timeout in hundredths of a second.
If the thread is not stopped at the end of specified duration, <Result> is set to False.
If this parameter is not specified or corresponds to the Infinite constant, the wait is infinite.
This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
the duration in a readable format (e.g., 1 s or 10 ms).

Wait for the end of the thread execution (use of a Thread variable) Hide the details

<Result> = ThreadWait(<Thread to wait for> [, <Maximum timeout>])

<Result>: Boolean

True if the thread was stopped or if the thread does not exist,
False if the thread is not stopped (the maximum duration is exceeded).

<Thread to wait for>: Thread variable

Name of the Thread variable that corresponds to the thread that must reach the end of its execution.

<Maximum timeout>: Optional integer, optional duration or optional constant

Maximum timeout in hundredths of a second.
If the thread is not stopped at the end of specified duration, <Result> is set to False.
If this parameter is not specified or corresponds to the Infinite constant, the wait is infinite.
This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
the duration in a readable format (e.g., 1 s or 10 ms).

Business / UI classification: Neutral code

Component: wd270vm.dll