@SetTaskTimeout
Syntax
@SetTaskTimeout(FN1);
@SetTaskTimeout(FN1;FN2);
@SetTaskTimeout(FN1;FN2;TEXT3);
@SetTaskTimeout(FN1;FN2;TEXT3;TEXT4);
Description
Enables task timeout monitoring for the task that calls @SetTaskTimeout.
FN FN1 specifies the time, in seconds, that the task may still take after the @Function call until the next call to @SetTaskTimeout oder @ClearTaskTimeout or until the end of the task.
If the specified time is exceeded by the task, a mail is sent (see TEXT3/TEXT4).
FN FN2 specifies the interval, in seconds, at which the mail should be repeated. If FN FN2 is specified as 0 (NULL), the mail is not repeated.
TEXT TEXT3 specifies the mail address to which the mail should be sent.
(If TEXT TEXT3 is not specified, the address specified in NOTES.INI under APITimeoutMailAdr is used. If NOTES.INI does not contain an APITimeoutMailAdr entry, the default mail address is APITimeoutMessages.)
In TEXT TEXT4 can be used to pass a TEXT value of up to 240 characters, which is listed in the mail under "Additional Info".
The return value of @SetTaskTimeout is NUMBER 1 on success; otherwise @ERROR.
Example: @SetTaskTimeout(FN1)
Ret:=@SetTaskTimeout(120);
If the task continues to run for more than @SetTaskTimeout after calling 120 seconds, a timeout warning mail is sent once to the default mail address.
Example: @SetTaskTimeout(FN1;FN2)
Ret:=@SetTaskTimeout(120;60);
If the task continues to run for more than @SetTaskTimeout after calling 120 seconds, a timeout warning mail is sent every 60 seconds to the default mail address.
Example: @SetTaskTimeout(FN1;FN2;TEXT3)
Ret:=@SetTaskTimeout(120;60;"Administrators");
If the task continues to run for more than @SetTaskTimeout after calling 120 seconds, a timeout warning mail is sent every 60 seconds, a timeout warning mail is sent to the mail address Administrators.
Example: @SetTaskTimeout(FN1;FN2;TEXT3;TEXT4)
Ret:=@SetTaskTimeout(120;60;"Administrators";"Zusatz Information");
If the task continues to run for more than @SetTaskTimeout after calling 120 seconds, a timeout warning mail is sent every 60 seconds, a timeout warning mail is sent to the mail address Administrators. The mail lists the Zusatz Information under "Additional Info".
Note : This text was machine-translated and may contain inaccuracies.
