function prematurely ends a CSPro application. If the function is used in a data entry application, the optional numeric expression stop_code
determines whether data entry is stopped just for the current case or whether the entire data entry application is closed. If stop_code
is not specified or is 0, entry of the current case is stopped (the same a pressing the stop button), but CSEntry remains active. If stop_code
is 1, entry of the current case is stopped and CSEntry terminates.
In a data entry application, if the function is executed in the postproc
of the first (highest) level then the data for the case is saved. Otherwise, any data entered for the current case is lost. If you want to avoid losing data, you can call savepartial
just before the stop
If the function is used in a batch edit application, the stop_code has no effect. The run is always terminated. If an output file was specified in the batch run, neither the current case nor subsequent cases will be saved to the output file.
The function returns a logical value of 0 (false) if the program cannot be stopped (for example, if the function is called from an external form).