USER_STATE—Save or Restore User State

The USER_STATE assignment statement saves or restores the state of edit profile values, FIND, CHANGE, SEEK, and EXCLUDE values, and panel and cursor values.

Syntax


Assignment statement syntax

>>-ISREDIT--(varname)-- = --USER_STATE-------------------------><


>>-ISREDIT--USER_STATE-- = --(varname)-------------------------><

varname: The name of a variable to contain your status information.
Note: The information in the variable is saved in an internal format that is subject to change. Dependence on the format can lead to macro errors.

Description

USER_STATE can be used at the beginning of a macro to save conditions, and at the end of a macro to restore the conditions that may have changed during processing. Many of the values saved by USER_STATE can be saved and restored individually. The USER_STATE assignment statement is a simple way of saving many values with a single statement.

These edit modes and values are saved and restored by USER_STATE:

  AUTOLIST  CURSOR        NOTES    RECOVERY
  AUTONUM   HEX           NULLS    STATS
  AUTOSAVE  IMACRO        NUMBER   TABS
  BOUNDS    MASKLINE      PACK     TABSLINE
  CAPS      MODEL CLASS   PROFILE

Return codes

0: Normal completion
20: Severe error

Examples

To save the user state in variable &STATUS:

ISREDIT (STATUS) = USER_STATE

To restore the user state from variable &STATUS:

ISREDIT USER_STATE = (STATUS)