The communications area of the “good night” program
Figure 1 shows the communications area passed to the “good night” program.
Figure 1. Communications area passed
to the “good night” program (assembler)
DFHSNGS
DFHSNGS_FIXED DS 0CL64 Fixed part of parm. list
GNTRAN_START_TRANSID DS CL4 TRANSID that invoked GNTRAN
GNTRAN_PSEUDO_CONV_FLAG DS CL1 Pseudoconversational flag
GNTRAN_SCREEN_TRUNCATED DS CL1 Screen buffer truncation flag
GNTRAN_TRANSLATE_TIOA DS CL1 Uppercase translation flag
DS CL9 Reserved
GNTRAN_TIMEOUT_TIME DS CL8 Time of terminal timeout
GNTRAN_TIMEOUT_REASON DS CL1 Reason for timeout
DS CL11 Reserved
GNTRAN_PSEUDO_CONV_TRANSID DS CL4 Next transaction ID
GNTRAN_SCREEN_LENGTH DS FL2 Length of screen buffer
GNTRAN_CURSOR_POSITION DS FL2 Cursor position
GNTRAN_SCREEN_WIDTH DS FL2 Width of screen
GNTRAN_SCREEN_HEIGHT DS FL2 Height of screen
GNTRAN_USER_FIELD DS CL16 Available to user program
DFHSNGS_VARIABLE DS 0X Variable part of parameter list
GNTRAN_SCREEN_BUFFER DS 0X Contents of screen buffer
- GNTRAN_START_TRANSID
- The identifier of the transaction that started the “good night” transaction. If it was started by CICS® because of a terminal timeout, GNTRAN_START_TRANSID is set to 'CEGN'. Your program should examine this field to check that timeout processing is appropriate (that is, that the “good night” transaction was started because of a terminal timeout and for no other reason).
- GNTRAN_PSEUDO_CONV_FLAG
- A flag indicating whether the terminal timed out during a pseudoconversational
transaction.
- Y
- The terminal timed out between transactions that form part of a pseudoconversational application.
- N
- The terminal did not time out between transactions that form part of a pseudoconversational application.
- GNTRAN_SCREEN_TRUNCATED
- A flag indicating whether the 3270 screen buffer had to be truncated.
- Y
- The screen buffer was truncated.
- N
- The screen buffer was not truncated.
- GNTRAN_TRANSLATE_TIOA
- An internal flag indicating whether DFHZSUP is to translate the
TIOA to uppercase, if required by the TYPETERM or PROFILE setting:
- Y
- The TIOA is to be translated.
- N
- Uppercase translation is to be bypassed.
- GNTRAN_TIMEOUT_TIME
- The time that the terminal timed out, in CICS ABSTIME format.
- GNTRAN_TIMEOUT_REASON
- The reason for the timeout:
- T
- No input from the terminal
- X
- An XRF takeover.
- GNTRAN_PSEUDO_CONV_TRANSID
- The identifier of the next transaction, if the terminal timed out during a pseudoconversational sequence. (If the terminal did not time out during a pseudoconversational sequence, the value of this field is meaningless.)
- GNTRAN_SCREEN_LENGTH
- The length of the screen buffer.
- GNTRAN_CURSOR_POSITION
- The cursor position.
- GNTRAN_SCREEN_WIDTH
- The width of the screen in use when the terminal timed out.
- GNTRAN_SCREEN_HEIGHT
- The height of the screen in use when the terminal timed out.
You can use GNTRAN_SCREEN_WIDTH and GNTRAN_SCREEN_HEIGHT to decide whether to use the ERASE DEFAULT or ERASE ALTERNATE option when restoring the user’s screen.
- GNTRAN_USER_FIELD
- This field is available for use by your “good night” user program. It is initialized to binary zeroes and is not changed by CICS. You can use it to help develop a pseudoconversational “good night” transaction.
- GNTRAN_SCREEN_BUFFER
- A variable length field containing the contents of the screen buffer.