Thread (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Declaration
Properties specific to the description of Thread variables
WLanguage functions that manipulate Thread variables

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Thread (Type of variable)

In french: Thread

The Thread type allows you to define all the characteristics of a thread. The characteristics of this thread can be defined and modified using different WLanguage properties.

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

Example

// Declare a variable to handle a thread
t is Thread
// Build a thread and trigger its execution on a procedure
t = ThreadExecute(Proc, ("First parameter", 2))

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

Declaration

Declaring a non-described thread Hide the details

MyVariable is Thread

In this case, the thread is not described. The variable will have to be assigned with an existing thread or with the result of one of the thread execution functions.

Describing a thread via the Thread type Hide the details

MyVariable is Thread (<Procedure> [, <Parameters> [, <Options>]])

<Procedure>: Character string or Procedure variable

Procedure to run. This parameter can correspond to:
the name of procedure to run.
the name of Procedure variable corresponding to the procedure to run.

<Parameters>: List of values enclosed in brackets and separated by commas

Parameters of procedure to run. This list of parameters has the following format:

(<Parameter 1>, ..., <Parameter N>)

where:
<Parameter 1>: First procedure parameter.
...
<Parameter N>: Nth procedure parameter.

<Options>: Optional Integer constant

Mode for starting the thread.
threadWaitForStart Waits for the actual start of the thread before continuing the execution.
threadGlobalContext Forces the use of the global context of the project if the thread is run from a window. The thread will continue to run until the application is closed.
The window context is used by default, therefore the thread is stopped when closing the window.
threadNormal Starts the thread in normal mode. The HFSQL context is copied during the first use of a HFSQL feature.
threadFullCopyHFSQLContext
(Default value) Triggers the immediate copy of current HFSQL context.
Recommended if the thread must take into account the current positions in the files and queries of caller context.
threadLightCopyHFSQLContext Triggers the immediate copy of part of current HFSQL context.
Are stored:
the directories where the HFSQL Classic data files are located.
HFSQL Client/Server connections.

In this case, the thread is described and its description can no longer be modified.
The thread is not executed automatically, so a declaration alone will not start the execution of the thread. You must call one of the thread execution functions to start the thread execution.

Remarks

Properties specific to the description of Thread variables

The following properties can be used to handle a Thread variable:

Property name	Type used	Effect

StopRequested	Boolean	True if the thread was requested to stop, False otherwise. This property is read-only.
Report	Integer constant	Thread status: threadStopRequested: Thread stop has been requested. threadRunning: The thread is running. threadNotExecuted: The thread has not been executed. threadSuspended: The thread is suspended. threadEnded: The thread exists but it has ended. This property is read-only.
nom	Character string	Thread name. This property is read-only.
Priority	Integer constant	Current priority level of thread: PriorityHigh: High priority. PriorityNormal: Standard priority. PriorityLow: Low priority.
Versions 26 and later ReturnedValue New in version 26 ReturnedValue ReturnedValue	Value returned by the thread.	Caution: 0 If the thread is completed without a fatal error, the property returns the return value(s) from the main Procedure of the thread. This property is read-only. Reminder: The Property Report allows to know the report of the thread. It is possible to wait for the end of an thread with the ThreadWait function..

WLanguage functions that manipulate Thread variables


Versions 09 and later ThreadExecute New in version 09 ThreadExecute ThreadExecute	Starts the execution of a secondary thread.
Versions 25 and later ThreadRequestStop New in version 25 ThreadRequestStop ThreadRequestStop	Sends a stop request to a thread.
Versions 09 and later ThreadSendSignal New in version 09 ThreadSendSignal ThreadSendSignal	The current thread sends a signal to the specified thread in order to unlock it.
Versions 09 and later ThreadWait New in version 09 ThreadWait ThreadWait	Waits for the end of execution of specified thread.