HAddTask (Function)

Compatibility with version 12: For backward compatibility with version 12, you also have the ability to define a task via the HScheduledTask structure. This task will run the specified stored procedure (or will perform a database backup).

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

Versions 22 and later

This function is now available in Universal Windows 10 App mode.

New in version 22

This function is now available in Universal Windows 10 App mode.

Versions 24 and later

This function is now available for iPhone/iPad applications.

New in version 24

This function is now available for iPhone/iPad applications.

Example

MyTask is hScheduledTask
MyTask..Description = "Scheduled backup " + CR + ...
DateToString(DateSys(), maskSystemDate) + ...
" at" + TimeToString(TimeSys(), "HH:MM:SS")
MyTask..Month = "*"
MyTask..DayOfWeek = "*"
MyTask..DayOfMonth = "*"
MyTask..Hour = EDT_Time..Hour
MyTask..Minute = EDT_Time..Minute
MyTask..NumberExecution = 1
MyTask..Procedure = "HBackup"
Add(MyTask..Parameter, gsNameCSDatabase + "/LOG_TASKS.FIC")
Add(MyTask..Parameter, gsNameCSDatabase + ".ScheduledBackup")
Add(MyTask..Parameter, True)
Add(MyTask..Parameter, MyTask..Description)
nID is int = HAddTask(gsCSConnection, MyTask)

Syntax

Creating a task from a hScheduledTask variable Hide the details

<Result> = HAddTask(<Connection> , <Scheduled task>)

<Result>: Integer

Identifier of scheduled task,
-1 if an error occurred. HErrorInfo is used to identify the error.

<Connection>: Character string (with or without quotes) or Connection variable

Connection for which a task must be added. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.

<Scheduled task>: hScheduledTask variable

Name of hScheduledTask variable used.

Creating a task from the hScheduledTask structure (compatibility with version 12) Hide the details

<Result> = HAddTask(<Connection> , <Stored procedure> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: Character string

Identifier of scheduled task,
-1 if an error occurred. HErrorInfo is used to identify the error.

<Connection>: Character string (with or without quotes) or Connection variable

Connection for which a task must be added. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a Connection variable.

<Stored procedure>: WLanguage procedure

Name of WLanguage stored procedure that will be run when triggering the task. This parameter has the following format: "<Database name>\<Name of stored procedure>". If this name corresponds to "HBackup", the scheduled task will perform a backup.

<Parameter 1>: Type of optional parameter

Parameter that will be passed to the stored procedure. For a backup, the parameters to pass are the ones of HBackup, except for the connection.

<Parameter N>: Type of optional parameter

Parameter that will be passed to the stored procedure. For a backup, the parameters to pass are the ones of HBackup, except for the connection.

Remarks

Necessary rights

To add a task, you must have:

the corresponding rights (hRightsManageTask constant) on the server,
Versions 23 and later
the rights to connect (hRightsConnection or hRightsEncryptedConnection) to each relevant database,
New in version 23
the rights to connect (hRightsConnection or hRightsEncryptedConnection) to each relevant database,
the rights to connect (hRightsConnection or hRightsEncryptedConnection) to each relevant database,
the rights to run the command linked to the scheduled task.

The task will be run with the account of user who created the task.

Caution: The scheduled task will not be performed if the server is switched off. The scheduled task will be performed at the next available date when the server is switched on.

Component : wd250hf.dll