Stop statement (LotusScript® Language)

Simulates the occurrence of a breakpoint.

Syntax

Stop

Usage

The Stop statement operates as follows when run on the server:

  • If the remote debugger is not running or is running but not enabled, Stop is ignored. Performance of the agent is not affected.
  • If the remote debugger is running and enabled, STOP waits according to the time-out value specified in the server record. (Stop uses the 'Agent wait at start time' value in the Remote Debug Manager tab of the Server Tasks tab.) If the debugger does not attach to that agent within the specified time-out value, execution continues. So the STOP statement does not stop the agent completely, but waits to allow the user to attach the remote debugger to it.
  • If the remote debugger is attached, the agent stops at the Stop statement as if a breakpoint was set.

The Stop statement operates as follows when in debug mode (File->Tools->Debug LotusScript®) on the client:

  • If the agent is running as a scheduled agent in the background, Stop is ignored.
  • If the agent is run from the Agents or Actions menu, the Stop statement suspends execution of the script and transfers control to the LotusScript® debugger as though a breakpoint is set at the Stop statement.
  • When not in debug mode, the Stop statement is ignored.

The Stop statement is legal within a procedure or class. It is not legal at the module level.