SMS_DefineEndUserCancellation

Owned by Martin Gudme Søndergaard
Oct 26, 2022
1 min read

SMS_DefineEndUserCancellation(iMax, iTimeOut, sMode)

Option

Description

Type

iMax
iTimeOut
sMode

Maximum number of cancellations
End User cancellation date
End User Cancellation Mode (see Description)

Integer
Integer
String

Return Type

Boolean, TRUE if function completed successfully.

Description

Defines End User cancellation.
iMax defines the maximum number of times the End User can cancel the Job.
iTimeOut defines the expiration date. Date format is YYYYMMDD.
sMode defines the behaviour of End User cancellation.
The value of sMode can be:
-"If User Logged On": If an End User is logged on to the Computer a cancellation message will be displayed.
-"Always": The End User cancellation message will always be displayed.
-"Never": End User cancellation message is deactivated.

Example

<Add Function Scripting Guidelines here>

bStatus=True
If bStatus Then bStatus=IncludeScript("customlib.cis")
If bStatus Then bStatus=IncludeScriptingLibrary("CapaInstaller Scripting Library.cin")

If bStatus Then bStatus=Job_Start("WS","EnvManipulation","1.0","Env_test.log","CONFIGURE")
If bStatus Then bStatus=SMS_DefineEndUserCancellation(10, 20050701, "IF USER LOGGED ON")
If bStatus Then bStatus=SMS_CheckMaxEndUserCancellation()
If bStatus AND gbValue Then MsgBox("# of cancellations has been exceeded, proceeding with Job execution")
Job_End(bStatus)

See Also