TOGGLE_SYSTEM_STATUS

Use the TOGGLE_SYSTEM_STATUS script function to stop or start the automatic processing of a client. For more information, see System Monitoring.

Important Considerations

Keep the following rules and behaviors in mind when using this script function:

• You need the following privilege Change system status (STOP/GO).

• This script function writes all open transactions of the script to the AE database. For more information, see Script Processing.

Syntax

TOGGLE_SYSTEM_STATUS (Status)

Parameters

Parameter	Description	Format	Allowed Values
Status	Changes the status.	AE name, script literal, or script variable	STOP: Stops the automatic processing of a client. GO: Starts the automatic processing of a client.

Return Codes

The script function returns the following codes:

• 0: The client status has successfully been changed.
• 9: The required privilege for changing the client status is missing.

Examples

The following example stops automatic processing. The return code of this script function is written to the report:

:SET &RET# = TOGGLE_SYSTEM_STATUS(STOP)

:PRINT &RET#

See also: