ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / WLanguage functions / Standard functions / Windows functions / Windows Scheduler functions
  • Information not retrieved: The password
  • Additional information filled only by SchedulerTaskProperties
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Reads the properties of a scheduled task and updates the ScheduledTask structure.
Reminder: The triggers (events that will start the task) are returned by SchedulerTriggerProperties.
Example
// Read the properties of MyTask
SchedulerTaskProperties("MyTask")
Info("The MyTask task is associated with the application " + ScheduledTask.Application)
Syntax
<Result> = SchedulerTaskProperties(<Task name>)
<Result>: Boolean
  • True if the task properties have been read,
  • False if an error occurred (the task does not exist for example).
<Task name>: Character string
Name of the task associated with the trigger to be retrieved. This name was defined when the task was created by SchedulerAddTask.
Remarks

Information not retrieved: The password

When using SchedulerTaskProperties, the ScheduledTask.Password variable is automatically initialized with an empty string ("").
During the next call to SchedulerModifyTask, the password will be stored if no new value was specifically assigned to the ScheduledTask.Password variable (by direct assignment or via SchedulerReset).

Additional information filled only by SchedulerTaskProperties

When using SchedulerTaskProperties, several variables of the ScheduledTask structure are automatically updated. These variables are read-only. These variables are as follows:
ScheduledTask.ErrorCodeInteger.
Last error code returned by the task (0 if the task was successfully completed or if the program has never been started).
This variable is read-only and is updated with SchedulerTaskProperties.
ScheduledTask.LastRunDateDateTime.
Date of last task execution.
This variable is read-only and is updated with SchedulerTaskProperties.
ScheduledTask.NextRunTimeDateTime.
Date of next scheduled task execution.
This variable is read-only and is updated with SchedulerTaskProperties.
ScheduledTask.TriggerCountInteger.
Number of task triggers (events that will start the task).
This variable is read-only and is updated with SchedulerTaskProperties.
Business / UI classification: Business Logic
Component: wd290std.dll
Minimum version required
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 08/29/2022

Send a report | Local help