CBL_DEBUG_STOP

Enables a COBOL program to stop or suspend animation.

Note: This routine is supported for native COBOL only.

Syntax:

CALL "CBL_DEBUG_STOP" using  by value    flags
                               returning status-code

Parameters:

flags: Using call prototype (see Key) : cblt-os-flags; Picture: pic x(4) comp-5 (or pic x(8) comp-5 for 64-bit native programs only)
status-code: See Library Routines - Key

On Entry:

flags

Controls how animation stops. You can set the following bits:

Bit	Meaning
0	Animator detaches.
1	Animator terminates.

Comments:

If the program is being debugged when it calls CBL_DEBUG_STOP, then animation stops. The effect on Animator and the program that called CBL_DEBUG_STOP depends on the settings of bits 0 and 1 of flags:

Bit 0	Bit 1	Meaning
0	0	Execution of the calling program continues without animation until a subsequent event, such as a breakpoint, STOP RUN or CBL_DEBUG_START, is encountered. This is equivalent to pressing Z (for Zoom) in Animator.
0	1	Animator and the calling program both exit. This is equivalent to exiting Animator using the Quit option.
1	0	Animator detaches from the program and waits for a subsequent CBL_DEBUG_START with the same `identifier` string. Execution of the calling program continues without animation. Note: The detach call is asynchronous, and therefore, there is a risk that the process calls CBL_DEBUG_START again before Animator is back in its wait state. To ensure this does not happen, you can call CBL_DEBUG_START with a timeout of -1 (to wait indefinitely).
1	1	Animator detaches from the program and exits. Execution of the calling program continues without animation. This is equivalent to exiting Animator using the Detach option.

If the program is not being debugged when it calls CBL_DEBUG_STOP, then execution continues as if the routine had not been called.