CMS_DefineEndUserCancellation
Description
Section titled “Description”Defines end user cancellation. Call the function before Job_InstallationStart, which shows the cancellation message. The message isn’t shown when the package runs silently.
iMax defines maximum number of times the end user can cancel the job
iTimeOut defines the expiration date. Date format is YYYYMMDD. From this date, the job runs without asking the end user. 0 means no expiration date.
sMode defines the behaviour of End User cancellation. Then value can be:
· IF USER LOGGED ON: If an end user has been logged on to the computer the end user cancellation message will be displayed.
· ALWAYS: The end user cancellation message will always be displayed.
· NEVER: End user cancellation is deactivated. Any other value also deactivates end user cancellation.
When the end user has cancelled the job iMax times, the job runs without asking.
Syntax
Section titled “Syntax”CMS_DefineEndUserCancellation(iMax, iTimeOut, sMode) as Boolean
Parameters
Section titled “Parameters”iMax (Integer)
Section titled “iMax (Integer)”Maximum number of cancellations
iTimeOut (Integer)
Section titled “iTimeOut (Integer)”End user cancellation date
sMode (String)
Section titled “sMode (String)”End User cancellation mode (see description)
Return value
Section titled “Return value”Boolean. The function always returns TRUE.
Example
Section titled “Example”If bStatus Then bStatus = CMS_DefineEndUserCancellation(10, 20010621, "IF USER LOGGED ON")Related functions
Section titled “Related functions”CMS_JobRetryLater Job_InstallationStart Constants Package Property Variables Business Unit support