PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
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
HScheduledTask structure
In French: HTâchePlanifiée
HFSQLAvailable only with this kind of connection
The HScheduledTask structure is kept for backward compatibility (this structure will still be supported in the forthcoming version).
Since version 14, the HScheduledTask structure was replaced by the hScheduledTask type. All you have to do is declare a HScheduledTask variable to handle the scheduled tasks.
See the help page about the hScheduledTask type for more details.
The documentation about the HScheduledTask structure available in WINDEV, WEBDEV and WINDEV Mobile 14 is as follows.
 
Overview
The HScheduledTask structure is used to manage the scheduled tasks on the server. This structure is used to define the repetition characteristics of the task.
When the scheduled task is described via the structure, HAddTask is used to add the task onto the HFSQL server by linking the HScheduledTask structure and the procedure to run.
Details of the HScheduledTask structure
The following variables are used to manage the scheduled tasks on the server:
HScheduledTask.DescriptionCharacter string.
Description of the task
HScheduledTask.HourCharacter string.
Hour when the scheduled task must be run ("13" for example). This number is included between 0 and 23.
This parameter can also correspond to:
  • a list of numbers separated by commas: used to specify several hours.
  • an interval. For example, "9-13" (the task is scheduled for 9 o'clock, 10, 11 12 and 13 PM).
  • a star ("*") to specify the entire range.
  • an interval with a step, "*/2" for example to perform the task at every even hour.
HScheduledTask.DayOfWeekCharacter string.
Number of the day for which the scheduled task must be run ("2" for example). This number is included between 1 and 7 (1 = Monday, 2 = Tuesday, ...).
This parameter can also correspond to:
  • a list of numbers separated by commas: used to specify several days.
  • an interval. For example, "1-3" (the task is scheduled for Monday, Tuesday and Wednesday).
  • a star ("*") to specify the entire range.
  • an interval with a step, "*/2" for example to perform the task on every even day of the week.
  • the day of the week in letters ("monday", "tuesday", "wednesday", "thursday", "friday").
HScheduledTask.DayOfMonthCharacter string.
Number of the day for which the scheduled task must be run ("31" for example). This number is included between 0 and 31.
This parameter can also correspond to:
  • a list of numbers separated by commas: used to specify several days.
  • an interval. For example, "9-13" (the task is scheduled from the 9th to the 13th of the month).
  • a star ("*") to specify the entire range.
  • an interval with a step, "*/2" for example to perform the task on every even day of the month.
HScheduledTask.DayOfMonthOrDayOfWeekBoolean
Used to manage the following cases: execution every Monday 1st day of the month.
  • True to run the task every Monday AND the first day of the month (cumulated conditions).
  • False to run the task on Monday 1st (exclusive conditions).
HScheduledTask.MinuteCharacter string.
Minutes of the execution time of the scheduled task ("13" for example). This number is included between 0 and 59.
This parameter can also correspond to:
  • a list of numbers separated by commas: used to specify several minutes.
  • an interval.
  • a star ("*") to specify the entire range.
  • an interval with a step, "*/2" for example to perform the task at every even minute.
HScheduledTask.MonthCharacter string.
Number for the month when the scheduled task must be run ("11" for example). This number is included between 1 and 12.
This parameter can also correspond to:
  • a list of numbers separated by commas: used to specify several months.
  • an interval. For example, "9-12" (the task is scheduled for all the months of the last quarter).
  • a star ("*") to specify the entire range.
  • an interval with a step, "*/2" for example to perform the task every even month.
HScheduledTask.NumberExecutionCharacter string.
Number of times the task must be run.
This parameter can also correspond to:
  • The infinite constant.
The task will be triggered if the number of the month, the hours and the minutes correspond to the information defined in the structure and if DayOfMonth or DayOfWeek corresponds to the current day.
Examples
// Every Monday at 13:45
HScheduledTask.DayOfMonth = "*"
HScheduledTask.DayOfWeek = "1"
HScheduledTask.Month = "*"
HScheduledTask.Hour = "13"
HScheduledTask.Minute = "45"
HScheduledTask.NumberExecution = Infinite
// Every hour, 10 minutes after the hour
HScheduledTask.DayOfMonth = "*"
HScheduledTask.DayOfWeek = "*"
HScheduledTask.Month = "*"
HScheduledTask.Hour = "*"
HScheduledTask.Minute = "10"
HScheduledTask.NumberExecution = Infinite
// Every December 31 at 23:50
HScheduledTask.DayOfMonth = "31"
HScheduledTask.DayOfWeek = "0"
HScheduledTask.Month = "12"
HScheduledTask.Hour = "23"
HScheduledTask.Minute = "50"
HScheduledTask.NumberExecution = Infinite
Minimum required version
  • Version 11
This page is also available for…
Comments
Click [Add] to post a comment