SchedulerTaskStatus (Function)

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.

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Windows Scheduler functions

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

SchedulerTaskStatus (Function)

In french: PlanificateurEtatTâche

Gets or sets the status of a task created in the Windows scheduler.

Example

// L'interrupteur INT_ActiveTâche est coché si la tâche doit être activée
IF INT_ActiveTâche = True THEN
	// Activation de la tâche
	SchedulerTaskStatus("MaTache", scheduledTaskActivate)
ELSE
	// Désactivation de la tâche
	SchedulerTaskStatus("MaTache", scheduledTaskDisable)
END

Syntax

Getting the status of a task Hide the details

<Result> = SchedulerTaskStatus(<Task name>)

<Result>: Integer constant

Status of the specified task:
scheduledTaskCompleted The last execution of the task was ended by the user.
scheduledTaskDisabled The task is disabled (it will never be run until it is re-enabled).
scheduledTaskError The specified task does not exist.
scheduledTaskExecution The scheduled task is currently run.
scheduledTaskNoMoreExecuted The task will not be run anymore.
scheduledTaskNotExecuted The task was not run yet.
scheduledTaskNoTiming The task does not have any triggers, or all the triggers are invalid/disabled.
scheduledTaskReady The task is ready to be run, it is waiting in the scheduler.
scheduledTaskUnscheduled The task properties do not allow the task to be run.

Before the first execution of the task, <Result> is set to scheduledTaskNotExecuted.
During the execution of the task, <Result> is set to scheduledTaskExecution.
After the execution of the task, <Result> is set to scheduledTaskReady.

<Task name>: Character string

Name of the task to use. This task was created with SchedulerAddTask.

Changing the status of a task Hide the details

<Result> = SchedulerTaskStatus(<Task name> , <Action>)

<Result>: Integer constant

New status of the specified task:
scheduledTaskCompleted The last execution of the task was ended by the user.
scheduledTaskDisabled The task is disabled (it will never be run until it is re-enabled).
scheduledTaskError The specified task does not exist.
scheduledTaskExecution The scheduled task is currently run.
scheduledTaskNoMoreExecuted The task will not be run anymore.
scheduledTaskNotExecuted The task was not run yet.
scheduledTaskNoTiming The task does not have any triggers, or all the triggers are invalid/disabled.
scheduledTaskReady The task is ready to be run, it is waiting in the scheduler.
scheduledTaskUnscheduled The task properties do not allow the task to be run.

<Task name>: Character string

Name of the task to use. This task was created with SchedulerAddTask.

<Action>: Integer constant

Action that must be performed on the specified task:
scheduledTaskActivate Enables the specified task.
scheduledTaskComplete Ends the execution of the task if the status of the task is set to scheduledTaskExecution.
Note: This action is asynchronous: the task will probably not have been completed by the end of the call to the SchedulerTaskStatus.
scheduledTaskDisable Disables the specified task.
scheduledTaskExecute Runs the task immediately regardless of its schedule.
Note: This action is asynchronous: the task will probably not yet be running at the end of the call to the SchedulerTaskStatus.

Before the first execution of the task, <Result> is set to scheduledTaskNotExecuted.
During the execution of the task, <Result> is set to scheduledTaskExecution. After the execution of the task, <Result> is set to scheduledTaskReady.

Business / UI classification: Business Logic

Component: wd300std.dll