PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Information not retrieved: The password
  • Additional information, specified by SchedulerTaskProperties
  • Operating system required
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Reads the properties of a scheduled task and updates the ScheduledTask structure.
Reminder: The events that will trigger a task (the schedules of 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 successful,
  • False if an error occurred (the task does not exist for example).
<Task Name>: Character string (with quotes)
Name of the task associated with the schedule to retrieve. 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, specified 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 it is updated by SchedulerTaskProperties.
ScheduledTask.LastRunDateDateTime.
Date of last task execution.
This variable is read-only and it is updated by SchedulerTaskProperties.
ScheduledTask.TriggerCountInteger.
Number of task schedules (which means number of events that will trigger the task).
This variable is read-only and it is updated by SchedulerTaskProperties.
ScheduledTask.NextRunTimeDateTime.
Date of next scheduled task execution.
This variable is read-only and it is updated by SchedulerTaskProperties.

Operating system required

The SchedulerXXX functions are not available in Windows NT if a version earlier than Internet Explorer 5.0 is installed.
Components
WINDEVReports and Queries wd230std.dll
Minimum required version
  • Version 10
This page is also available for…
Comments
Click [Add] to post a comment