|
|
|
|
- Overview
- Details of the TriggerScheduledTask structure
- Variables that can be used according to the type of task
- Example
- Example for adding a task
TriggerScheduledTask structure
The TriggerScheduledTask structure is used to define all the events that will define the execution of a task. The variables of this structure are reinitialized by SchedulerReset. The default trigger is set to every day at 9:00 AM. Details of the TriggerScheduledTask structure The parameters to be specified in the TriggerScheduledTask structure depend on the type of trigger defined for the scheduled task. Indeed, a scheduled task can be: run on a daily, weekly or monthly basis, run once, run when the computer is started, run when the system is idle. The type of trigger defined for the scheduled task is determined by the TriggerScheduledTask.Type variable. Below are the details of this and all the other variables of the TriggerScheduledTask structure. | | TriggerScheduledTask.BeginDate | Date
Date from which the task can be performed. By default, this date corresponds to the creation date of the task. Type of associated task: Daily task, weekly task and monthly task. | TriggerScheduledTask.Caption | Character string
Text of the trigger (event that starts the scheduled task).
This variable is read-only and it is updated when a trigger is read (SchedulerTriggerProperties) | TriggerScheduledTask.Date | Date
Date when the task will be run. Type of associated task: Task run once only. | TriggerScheduledTask.Day | Integer
The task will be performed on this day of the month. Can correspond to: - the number of a day (between 1 and 31)
- the name of a day + its position in the monthExample: 1st Monday of the month: schedMonday + schedFirst
The available values are: - schedMonday, schedTuesday, schedWednesday, schedThursday, schedFriday, schedSaturday, schedSunday
- schedFirst, schedSecond, schedThird, schedFourth, schedLast. The task is performed every 1st of each month by default.
Type of associated task: Monthly task | TriggerScheduledTask.DayOfWeek | Integer
The task will be performed on this day of the week. Corresponds to the name of a day + its position in the month
Example: 1st Monday of the month: schedMonday + schedFirst
The available values are: schedMonday, schedTuesday, schedWednesday, schedThursday, schedFriday, schedSaturday, schedSunday
The task is performed every Monday by default.
Type of associated task: Weekly task | TriggerScheduledTask.EndDate | Date
Date from which the task will no longer be performed. To specify no end date, use an empty string. No end date is specified by default. Type of associated task: Daily task, weekly task and monthly task. | TriggerScheduledTask.ForcedStop | Boolean.
If this parameter is set to True, stops the task currently run when the repeat duration is exceeded. This variable is set to False by default. Type of associated task: Daily task, weekly task, monthly task and task run once. | TriggerScheduledTask.IdleWait | Integer in minutes
Amount of idle time required before performing the task. This duration is set to 10 minutes by default. Type of associated task: Run when the system is idle | TriggerScheduledTask.Interval | Integer
Number of days or number of weeks between each execution. This variable is set to 1 by default. Type of associated task: Daily task or weekly task. | TriggerScheduledTask.Month | Integer
The task will be performed during this month. Corresponds to one or more months: schedJanuary, schedFebruary, schedMarch, schedApril, schedMay, schedJune, schedJuly, schedAugust, schedSeptember, schedOctober, schedNovember, schedDecember.
Example: schedJanuary + schedAugust: the task will be performed in January and in August.
The task is performed every month by default.
Type of associated task: Monthly task | TriggerScheduledTask.RepeatDuration | Integer in minutes.
The task will be repeated during the specified duration. This duration is set to 60 minutes by default. Type of associated task: Daily task, weekly task and monthly task. | TriggerScheduledTask.RepeatInterval | Integer in minutes
The task will be repeated during this interval (0 if the task must be performed once). The task is not repeated by default.
Type of associated task: Daily task, weekly task, monthly task and task run once. | TriggerScheduledTask.Time | Time
Time when the task will be run. This variable is set to 9:00 AM by default Type of associated task: Daily task, weekly task, monthly task and task run once. | TriggerScheduledTask.Type | This variable can take one of the following values: | | schedDaily (default value) | Run on a daily basis | schedIdle | Run when the system is idle. | schedLogon | Run when starting a session. | schedMonthly | Run on a monthly basis. | schedOnce | Run once. | schedSystemStart | Run at system startup. | schedWeekly | Run on a weekly basis. |
|
Variables that can be used according to the type of task The table below presents the variables that can be used according to the type of task: | | schedDaily | TriggerScheduledTask.Time TriggerScheduledTask.Interval TriggerScheduledTask.BeginDate TriggerScheduledTask.EndDate TriggerScheduledTask.RepeatInterval TriggerScheduledTask.RepeatDuration TriggerScheduledTask.ForcedStop | schedIdle | No specific variable | schedLogon | No specific variable | schedMonthly | TriggerScheduledTask.Time TriggerScheduledTask.Day TriggerScheduledTask.Month TriggerScheduledTask.BeginDate TriggerScheduledTask.EndDate TriggerScheduledTask.RepeatInterval TriggerScheduledTask.RepeatDuration TriggerScheduledTask.ForcedStop | schedOnce | TriggerScheduledTask.Time TriggerScheduledTask.Date TriggerScheduledTask.RepeatInterval TriggerScheduledTask.RepeatDuration TriggerScheduledTask.ForcedStop | schedSystemStart | No specific variable | schedWeekly | TriggerScheduledTask.Time TriggerScheduledTask.Interval TriggerScheduledTask.BeginDate TriggerScheduledTask.EndDate TriggerScheduledTask.RepeatInterval TriggerScheduledTask.RepeatDuration TriggerScheduledTask.ForcedStop |
Example for adding a task SchedulerReset() // Create the scheduled task ScheduledTask.Application = "MyExecutable.exe" ScheduledTask.CommandLine = QryAllAboutBackup.Name ScheduledTask.SystemOn = True ScheduledTask.Comment = "WINDEV program"  // Create the triggers for the scheduled task // RADIO_BackupType is a radio button proposing // a single backup, a weekly backup or a monthly backup ...  TriggerScheduledTask.Type = RADIO_BackupType  // Execution date of the single backup IF RADIO_nBackupType = schedDaily THEN IF EDT_SingleDate <> "" THEN IF EDT_SingleTime <> "" THEN TriggerScheduledTask.Date = EDT_SingleDate TriggerScheduledTask.Time = EDT_SingleTime ELSE Info("Enter a valid backup time.") RETURN END ELSE Info("Enter a valid backup date.") RETURN END END // Monthly backup IF RADIO_BackupType = schedMonthly THEN IF EDT_SingleTime <> "" THEN TriggerScheduledTask.Day = RADIO_DayOfMonth TriggerScheduledTask.Time = EDT_SingleTime ELSE Info("Enter a valid backup time.") RETURN END END // Weekly backup IF RADIO_BackupType = schedWeekly THEN IF EDT_SingleTime <> "" THEN TriggerScheduledTask.DayOfWeek = RADIO_DayOfWeek TriggerScheduledTask.Time = EDT_SingleTime ELSE Info("Enter a valid backup time.") RETURN END END IF NOT SchedulerAddTask("MyTask") THEN Error(ErrorInfo()) ELSE Info("The application was added to the task manager of Windows") END
This page is also available for…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|