Host Environment Commands › ADDRESS EPI Commands › EPI DISABLE Command—Disable Virtual Terminals › EPI GETSCRN—Display Screen Image

EPI GETSCRN—Display Screen Image

Use this command to fetch the current screen image from a CA OPS/MVS monitored VTAM session and display it on the terminal. Optionally, GETSCRN can store the screen image in OPS/REXX variables describing the contents and state of the screen.

This command has the following format:

ADDRESS EPI "GETSCRN keywords"
  {SESSION(sessid)}
  [CMDRESP(dest)]
  [PREFIX(prefix)]
  [SUBSYS(ssid)]
  [TRUNCATE(YES|NO)]

SESSION

Defines the one- to eight-character session ID of the monitored session.

CMDRESP

(Optional) The CMDRESP operand specifies the kind of variables to store the fetched screen image. The dest value can be either CLIST or REXX. CLIST is the default.

PREFIX

(Optional) The PREFIX operand specifies the one- to six-character prefix to be used when creating the CLIST or REXX variables. For more details on these variables, see Using SESSCMD in a CLIST or REXX EXEC in this chapter.

SUBSYS

(Optional) The SUBSYS operand addresses the command to a copy of CA OPS/MVS with a subsystem ID other than the default subsystem ID, which is OPSS.

TRUNCATE

(Optional) The TRUNCATE operand specifies whether CA OPS/MVS truncates the screen image display when GETSCRN is entered from a TSO terminal. Possible TRUNCATE values are YES or NO.

Default: YES

Examples: GETSCRN command

• The following command fetches the current screen of the VTAM session with session ID CICS2 and displays it on the TSO terminal:

  GETSCRN SESSION(CICS2)
  

• This example shows the use of GETSCRN in a REXX program. This REXX program retrieves the current screen from a VTAM session and displays all the CLIST variables that CA OPS/MVS generates from the display.

  SESSION = ARG(1)
  ADDRESS EPI
  'GETSCRN SESSION('SESSION') PREFIX(LINE)'
  IF RC > 0 THEN EXIT
  SAY 'THE FOLLOWING VARIABLES HAVE BEEN SET'
  SAY 'CSRCOL =' CSRCOL
  SAY 'CSRPOS =' CSRPOS
  SAY 'CSRROW =' CSRROW
  SAY 'SCREEN =' SCREEN
  SAY 'SCRLEN =' SCRLEN
  SAY 'SCRSIZE =' SCRSIZE
  SAY 'SCRSTAT =' SCRSTAT
  SAY 'SCRWDTH =' SCRWDTH
  DO I=1 TO LINE.0
    SAY I ':' LINE.I
  END
  RETURN