INQUIRE TERMINAL

Retrieve information about a terminal or session.

Read syntax diagramSkip visual syntax diagramINQUIRE TERMINAL/NETNAME
 
>>-INQUIRE TERMINAL(data-value)--+--------------------+--------><
                                 '-NETNAME(data-area)-'
 

The following options apply to both the INQUIRE TERMINAL and the INQUIRE NETNAME command.

Read syntax diagramSkip visual syntax diagramINQUIRE TERMINAL
 
   .---------------------------.
   V                           |
>>---+-----------------------+-+-------------------------------->
     +-ACCESSMETHOD(cvda)----+
     +-ACQSTATUS(cvda)-------+
     +-ALTPAGEHT(data-area)--+
     +-ALTPAGEWD(data-area)--+
     +-ALTPRINTER(data-area)-+
     +-ALTPRTCOPYST(cvda)----+
     +-ALTSCRNHT(data-area)--+
     +-ALTSCRNWD(data-area)--+
     +-ALTSUFFIX(data-area)--+
     +-APLKYBDST(cvda)-------+
     +-APLTEXTST(cvda)-------+
     +-ASCII(cvda)-----------+
     +-ATISTATUS(cvda)-------+
     +-AUDALARMST(cvda)------+
     +-AUTOCONNECT(cvda)-----+
     +-BACKTRANSST(cvda)-----+
     +-COLORST(cvda)---------+
     +-CONSOLE(data-area)----+
     +-COPYST(cvda)----------+
     +-CORRELID(data-area)---+
     +-CREATESESS(cvda)------+
     +-DATASTREAM(cvda)------+
     +-DEFPAGEHT(data-area)--+
     +-DEFPAGEWD(data-area)--+
     +-DEFSCRNHT(data-area)--+
     +-DEFSCRNWD(data-area)--+
     +-DEVICE(cvda)----------+
     +-DISCREQST(cvda)-------+
     +-DUALCASEST(cvda)------+
     +-EXITTRACING(cvda)-----+
     +-EXTENDEDDSST(cvda)----+
     +-FMHPARMST(cvda)-------+
     +-FORMFEEDST(cvda)------+
     +-GCHARS(data-area)-----+
     +-GCODES(data-area)-----+
     +-HFORMST(cvda)---------+
     +-HILIGHTST(cvda)-------+
     +-KATAKANAST(cvda)------+
     +-LIGHTPENST(cvda)------+
     +-LINKSYSTEM(data-area)-+
     +-MAPNAME(data-area)----+
     +-MAPSETNAME(data-area)-+
     +-MODENAME(data-area)---+
     +-MSRCONTROLST(cvda)----+
     '-NATLANG(data-area)----'
 
   .-----------------------------.
   V                             |
>----+-------------------------+-+-----------------------------><
     +-NATURE(cvda)------------+
     +-NEXTTRANSID(data-area)--+
     +-NQNAME(data-area)-------+
     +-OBFORMATST(cvda)--------+
     +-OBOPERIDST(cvda)--------+
     +-OPERID(data-area)-------+
     +-OUTLINEST(cvda)---------+
     +-PAGEHT(data-area)-------+
     +-PAGESTATUS(cvda)--------+
     +-PAGEWD(data-area)-------+
     +-PARTITIONSST(cvda)------+
     +-PRINTADAPTST(cvda)------+
     +-PRINTER(data-area)------+
     +-PROGSYMBOLST(cvda)------+
     +-PRTCOPYST(cvda)---------+
     +-QUERYST(cvda)-----------+
     +-RELREQST(cvda)----------+
     +-REMOTENAME(data-area)---+
     +-REMOTESYSNET(data-area)-+
     +-REMOTESYSTEM(data-area)-+
     +-SCRNHT(data-area)-------+
     +-SCRNWD(data-area)-------+
     +-SECURITY(cvda)----------+
     +-SERVSTATUS(cvda)--------+
     +-SESSIONTYPE(cvda)-------+
     +-SIGNONSTATUS(cvda)------+
     +-SOSIST(cvda)------------+
     +-TASKID(data-area)-------+
     +-TCAMCONTROL(data-area)--+
     +-TERMMODEL(data-area)----+
     +-TERMPRIORITY(data-area)-+
     +-TERMSTATUS(cvda)--------+
     +-TEXTKYBDST(cvda)--------+
     +-TEXTPRINTST(cvda)-------+
     +-TRACING(cvda)-----------+
     +-TRANSACTION(data-area)--+
     +-TTISTATUS(cvda)---------+
     +-UCTRANST(cvda)----------+
     +-USERAREA(ptr-ref)-------+
     +-USERAREALEN(data-area)--+
     +-USERID(data-area)-------+
     +-USERNAME(data-area)-----+
     +-VALIDATIONST(cvda)------+
     +-VFORMST(cvda)-----------+
     '-ZCPTRACING(cvda)--------'
 

Conditions: END, ILLOGIC, NOTAUTH, TERMIDERR

For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

Description

The INQUIRE TERMINAL and INQUIRE NETNAME commands both return information about a particular terminal or session installed in a CICS region.

You can use these commands to inquire about any type of terminal resource, including:

You can also use INQUIRE TERMINAL to inquire about an APPC, LUTYPE6.1, or MRO session or, where there are parallel sessions, session group. To get full details about the associated connection, however, you must use an INQUIRE CONNECTION command.

Some of the options in this command return system status information, such as whether the terminal is acquired or not, whether it is in use by a task, and so on. Most options, however, reflect the definition of the terminal or session, modified, possibly, by subsequent SET TERMINAL commands or the information obtained from the hardware in a QUERY.

A terminal is specified by a TERMINAL resource definition and the TYPETERM definition to which it points. Characteristics shared by many terminals, such as screen size and 3270 features, are defined by TYPETERM, and those specific to one terminal, such as the name of the associated printer, are in the TERMINAL definition, which may have been autoinstalled. For a session, the CONNECTION defines shared properties and SESSIONS defines specifics. See the CICS® Resource Definition Guide for more information about TERMINAL, TYPETERM, SESSIONS, and CONNECTION resource definitions.

In most cases, options of this type have the same name--or one recognizably similar--as the option in the resource definition. Where this is not the case, the option descriptions that follow indicate the corresponding resource options.

INQUIRE NETNAME returns the same information as INQUIRE TERMINAL. With INQUIRE TERMINAL, you identify the object of your inquiry by providing its CICS terminal identifier in the TERMINAL option. NETNAME is optional. If you include it, CICS returns the network identifier in the data area you provide.

In an INQUIRE NETNAME command, the roles of TERMINAL and NETNAME are reversed. You identify the terminal about which you are inquiring by supplying its network identifier in NETNAME, and CICS returns the corresponding CICS terminal identifier in TERMINAL if you also include that option. TERMINAL must appear before NETNAME (if present) in an INQUIRE TERMINAL command, and vice versa in an INQUIRE NETNAME command.

All of the other options apply to both commands and return the same information. Not all options apply to all types of terminals, however. In particular, when CICS ships a terminal definition from the owning region to a remote region, an inquiry issued in the owning region (where the definition is of a real terminal) produces more information than an inquiry issued in the remote region, where the definition is a surrogate for the one in the owning region.

Remote terminals

In addition to links to local terminals or devices, some terminal definitions refer to remote terminals. A remote terminal is a terminal that is owned by another CICS system. The owning system is called the terminal-owning region (TOR). Note that different terminals may have different TORs. TOR here refers to the owning system for a particular terminal.

The way that the local system is connected to the TOR makes a difference to the information that the REMOTESYSTEM field returns.

If the TOR is directly connected to the local system, the REMOTESYSTEM field usually names the CONNECTION definition for the link. (It can name an indirect connection, but that is an unusual setup). In this case, the netname of the TOR is specified in the link CONNECTION definition.

If a remote terminal is on a system that is not directly linked to the TOR, the REMOTESYSTEM field can name one of two types of connection, as follows:

In both these cases, the LINKSYSTEM field of INQUIRE TERMINAL returns the "real" connection that is the next link towards the TOR. It is determined by looking at the logical chain of connections from the terminal in question to the "real" terminal entry. If the chain is broken (because a connection has not been installed yet, or has been discarded) LINKSYSTEM is not set. For a fuller explanation of the relationship between REMOTESYSTEM, REMOTESYSNET, and LINKSYSTEM, see Remote connections.

Browsing

You can also browse through the definitions of all the terminals installed in your system by using the browse options (START, NEXT, and END) on INQUIRE TERMINAL or INQUIRE NETNAME commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

ACCESSMETHOD(cvda)
returns a CVDA value indicating the access method defined for the terminal. CVDA values are:
BGAM
The access method is BGAM.
BSAM
The access method is BSAM.
CONSOLE
The terminal is an operating system console, accessed through MVS console support facilities.
NOTAPPLIC
The terminal is an MRO session.
TCAM
The access method is TCAM (DCB interface).
VTAM
The access method is VTAM.
ACQSTATUS(cvda) (VTAM only)
returns the same value as the TERMSTATUS option and is retained only for compatibility purposes. You should use TERMSTATUS in new applications.
ALTPAGEHT(data-area)
returns a halfword binary field giving the height (in lines) of the alternate page size. See also the DEFPAGEHT and PAGEHT options.
ALTPAGEWD(data-area)
returns a halfword binary field giving the width (in characters) of the alternate page size. See also the DEFPAGEWD and PAGEWD options.
ALTPRINTER(data-area)
returns the 4-character name of the printer designated for print key requests and ISSUE PRINT commands from tasks at this terminal when the printer named in the PRINTER option of the TERMINAL definition is not available.
ALTPRTCOPYST(cvda)
returns a CVDA value indicating whether CICS is to use the hardware copy feature to satisfy a print request on the printer named in the ALTPRINTER option. CVDA values are:
ALTPRTCOPY
CICS is to use the hardware copy feature.
NOALTPRTCOPY
CICS is not to use the hardware copy feature.
NOTAPPLIC
The terminal is not a VTAM terminal, or is a remote terminal, a surrogate terminal, or a model definition.
ALTSCRNHT(data-area)
returns a halfword binary field giving the height (in lines) of the alternate screen size. See also the DEFSCRNHT and SCRNHT options.
ALTSCRNWD(data-area)
returns a halfword binary field giving the width (in characters) of the alternate screen size. See also the DEFSCRNWD and SCRNWD options.
ALTSUFFIX(data-area)
returns the 1-character suffix that BMS appends to map set names for maps written to this terminal when the screen is the alternate size and suffixing is in use.

If ALTSUFFIX was not specified in the definition of this terminal, the byte returned contains x'00'. Notice that the value x'00' is not described as null, because this is a character field and, in that context, null refers to the blank character x'40', see Null values for a discussion of null values.

APLKYBDST(cvda)
returns a CVDA value indicating whether the terminal has the APL keyboard feature. CVDA values are:
APLKYBD
The terminal has the APL keyboard feature.
NOAPLKYBD
The terminal does not have the APL keyboard feature.
APLTEXTST(cvda)
returns a CVDA value indicating whether the terminal has the APL text feature. CVDA values are:
APLTEXT
The terminal has the APL text feature.
NOAPLTEXT
The terminal does not have the APL text feature.
ASCII(cvda)
returns a CVDA value indicating the type of ASCII code the terminal uses, if applicable. CVDA values are:
ASCII7
The code is 7-bit ASCII.
ASCII8
The code is 8-bit ASCII.
NOTAPPLIC
The terminal does not use ASCII.
ATISTATUS(cvda)
returns a CVDA value indicating whether CICS can initiate a task automatically (ATI) with this terminal as its principal facility.
ATI
The terminal can be used in ATI.
NOATI
The terminal cannot be used in ATI.
AUDALARMST(cvda)
returns a CVDA value indicating whether the terminal has the 3270 audible alarm feature. CVDA values are:
AUDALARM
The terminal has the audible alarm feature.
NOAUDALARM
The terminal does not have the audible alarm feature.
AUTOCONNECT(cvda)
returns a CVDA value indicating whether CICS should attempt to establish (bind) a session with this terminal when communication with VTAM is established. CVDA values are:
ALLCONN
CICS binds the session. This value is returned when the AUTOCONNECT value is ALL in the associated TYPETERM definition (when you are inquiring about a terminal) or ALLCONN in the SESSIONS definition (when you are inquiring about a session).
AUTOCONN
CICS binds the session. This value is returned when the AUTOCONNECT value is YES in the associated TYPETERM definition (in an inquiry about a terminal) or AUTOCONN in the SESSIONS definition (in an inquiry about a session).
NONAUTOCONN
CICS does not bind a session.
NOTAPPLIC
The terminal is not a VTAM terminal, or is a remote terminal, a surrogate, or a model.
BACKTRANSST(cvda)
returns a CVDA value indicating whether the terminal has the 3270 background transparency feature. Background transparency allows you to control whether the display area behind a character is clear (transparent) or shaded. CVDA values are:
BACKTRANS
The terminal has the background transparency feature.
NOBACKTRANS
The terminal does not have the background transparency feature.
COLORST(cvda)
returns a CVDA value indicating whether the terminal has the 3270 extended color feature, which allows colors to be selected for individual fields or characters. CVDA values are:
COLOR
The terminal has the extended color feature.
NOCOLOR
The terminal does not have the extended color feature.
Start of changeCONSOLE(data-area) End of change
Start of changereturns, for an MVS console only, a 12-byte string that identifies the console. If the device is not a console, CICS returns 12 blanks.

If the console is autoinstalled, or is defined explicitly with a console name, the name is returned in the first 8 bytes, and the last 4 bytes are blank.

End of change
COPYST(cvda)
returns a CVDA value indicating whether the control unit through which the terminal is attached includes the copy feature. COPYST applies only to 3270 terminals. CVDA values are:
COPY
The control unit has the copy feature.
NOCOPY
The control unit does not have the copy feature.
CORRELID(data-area)
returns an 8-character correlation-id that is only set for sessions, as follows:
  • For LU6.1 sessions, it is set to the value of NETNAMEQ.
  • For MRO sessions, it is set to the termid of the session at the other end of the MRO link to which this session is connected.
  • For LU6.2 sessions, it is an 8-character token that is common to the two sessions that are connected.

Using CORRELID, you can relate the two parts of an MRO, LU6.1, or LU6.2 conversation, and so discover, for example, which program is running a particular function shipping mirror.

CREATESESS(cvda) (VTAM only)
returns a CVDA value indicating whether CICS should attempt to acquire the terminal if it is required for an automatic task initiation (ATI) request. Only VTAM physical terminals can be acquired by CICS; sessions are not eligible. CVDA values are:
CREATE
The terminal can be acquired.
NOCREATE
The terminal cannot be acquired.
NOTAPPLIC
The terminal is not a VTAM terminal or is a session (APPC, LUTYPE6.1, or MRO).
DATASTREAM(cvda)
returns a CVDA value indicating the type of data stream used by the terminal. CVDA values are:
DS3270
The terminal uses the 3270 data stream.
NOTAPPLIC
The terminal does not use either the 3270 or SCS data stream.
SCS
The terminal uses SNA character strings.
DEFPAGEHT(data-area)
returns a halfword binary field giving the height (in lines) of the default page size. (The corresponding option in the TYPETERM definition is PAGESIZE.) See also the ALTPAGEHT and PAGEHT options.
DEFPAGEWD(data-area)
returns a halfword binary field giving the width (in characters) of the default page size. (The corresponding option in the TYPETERM definition is PAGESIZE.) See also the ALTPAGEWD and PAGEWD options.
DEFSCRNHT(data-area)
returns a halfword binary field giving the height (in lines) of the default screen size. See also the ALTSCRNHT and SCRNHT options.
DEFSCRNWD(data-area)
returns a halfword binary field giving the width (in characters) of the default screen size. See also the ALTSCRNWD and SCRNWD options.
DEVICE(cvda)
returns a CVDA value identifying the terminal or session type. CVDA values for this option are listed in CVDA values for the DEVICE option.
DISCREQST(cvda)
returns a CVDA value indicating whether CICS is to honor a request to disconnect the terminal. Disconnect requests result from an ISSUE DISCONNECT command, or a CESF (sign-off) task with the GOODNIGHT or LOGOFF option. CVDA values are:
DISCREQ
CICS will honor a request to disconnect this terminal (with a VTAM CLSDST request to terminate the session if the terminal is a VTAM terminal).
NODISCREQ
CICS will not honor a request to disconnect this terminal.
DUALCASEST(cvda)
returns a CVDA value indicating whether the terminal has a typewriter keyboard or an operator console keyboard. CVDA values are:
DUALCASE
The terminal has a typewriter keyboard.
NODUALCASE
The terminal has an operator console keyboard (this keyboard is not restricted to a single case), or is not a 3270 display.
EXITTRACING(cvda) (VTAM only)
returns a CVDA value indicating whether this terminal is traced when CICS VTAM exit tracing is active. (See the TCEXITSTATUS option in the INQUIRE TRACEFLAG command, on topic TCEXITSTATUS.) CVDA values are:
EXITTRACE
The terminal is traced.
NOEXITTRACE
The terminal will not be traced.
NOTAPPLIC
The terminal is not a VTAM terminal, or is a remote terminal, a surrogate terminal, or a model definition.
EXTENDEDDSST(cvda)
returns a CVDA value indicating whether the terminal supports the 3270 extended data stream. The terminal has this support if the TYPETERM definition specifies it either explicitly (in the EXTENDEDDS option) or implicitly, by specifying features that use the extended data stream (see the BACKTRANST, COLORST, HILIGHTST, MSRCONTROLST, OUTLINEST, PARTITIONSST, PROGSYMBOLST, SOSIST, and VALIDATIONST options of this command). Extended data stream support implies that the terminal accepts write-structured fields commands, including QUERY, and, conversely, support for QUERY (that is, a value of ALL or COLD for the QUERY option) implies support for the extended data stream. CVDA values are:
EXTENDEDDS
The terminal supports the extended data stream.
NOEXTENDEDDS
The terminal does not support the extended data stream.
FMHPARMST(cvda)
returns a CVDA value indicating whether BMS accepts user-supplied values for inclusion in a function management header (FMH) to be built by BMS. This support is available only on 3650 terminals. CVDA values are:
FMHPARM
BMS allows user-supplied values.
NOFMHPARM
BMS does not allow user-supplied values.
FORMFEEDST(cvda)
returns a CVDA value indicating whether the terminal has the forms feed feature. CVDA values are:
FORMFEED
The terminal has the forms feed feature.
NOFORMFEED
The terminal does not have the forms feed feature.
GCHARS(data-area)
returns a halfword binary field giving the graphic character set global identifier (GCSGID), which identifies the set of graphic characters that can be input or output at this terminal. (The corresponding option in the TYPETERM definition is CGCSGID.)

The GCHARS option applies only to graphic terminals; for others 0 is returned.

GCODES(data-area)
returns a halfword binary field giving the code page global identifier (CPGID), which identifies the EBCDIC code page that defines the code points for the characters that can be input or output at the terminal. (The corresponding option in the TYPETERM definition is CGCSGID.)

The GCODES option applies only to graphic terminals; for others 0 is returned.

HFORMST(cvda)
returns a CVDA value indicating whether the terminal has the horizontal forms feature, which is required for use of horizontal tabbing when formatting documents for output. CVDA values are:
HFORM
The terminal has the horizontal forms feature.
NOHFORM
The device does not have the horizontal forms feature.
HILIGHTST(cvda)
returns a CVDA value indicating whether the terminal has the 3270 extended highlighting facility, which enables fields or characters to be displayed in reverse-video, underlined, or blinking. CVDA values are:
HILIGHT
The terminal has extended highlighting.
NOHILIGHT
The terminal does not have extended highlighting.
KATAKANAST(cvda)
returns a CVDA value indicating whether the terminal is a Katakana terminal. CVDA values are:
KATAKANA
The terminal is a Katakana terminal.
NOKATAKANA
The terminal is not a Katakana terminal.
LIGHTPENST(cvda)
returns a CVDA value indicating whether the terminal has the 3270 selector pen feature. CVDA values are:
LIGHTPEN
The terminal has the selector pen feature.
NOLIGHTPEN
The terminal does not have the selector pen feature.
LINKSYSTEM(data-area)
returns the 4-character name of the connection that is the real link towards the TOR for a remote terminal entry, if it is available. It is not available if some connection definitions in the chain from the remote entry to the link system are missing.
MAPNAME(data-area)
returns the 7-character name of the map that was most recently referenced in the MAP option of a SEND MAP command processed for this terminal. If this terminal is a surrogate, and the terminal-owning system is a CICS Transaction Server for z/OS® region, the map name may be the last map sent by the terminal-owning region or another AOR in which this terminal has been represented as a surrogate device. The map name returned may no longer be held in the device buffer, because an intervening BMS command such as SEND TEXT or SEND CONTROL (or a terminal control SEND command), or operator action, may have partially or completely removed the map display. If the terminal is not supported by BMS (for example, this terminal is a session), or CICS has no record of any map being sent, the value returned is blanks.
MAPSETNAME(data-area)
returns the 8-character name of the mapset that was most recently referenced in the MAPSET option of a SEND MAP command processed for this terminal. If the MAPSET option was not specified on the most recent request, BMS uses the map name as the mapset name. In both cases, the mapset name used may be suffixed by a terminal or alternate suffix. If this terminal is a surrogate, the mapset name may be the last mapset used by the terminal-owning region or another AOR in which this terminal has been represented as a surrogate device. If the terminal is not supported by BMS (for example this terminal is a session), or CICS has no record of any mapset being used, the value returned is blanks.
Note:
See the CICS Application Programming Guide for information about mapset suffixing.
MODENAME(data-area) (APPC only)
returns the 8-character name of the session group to which the session about which you are inquiring belongs (from the LOGMODE option of the SESSIONS definition). MODENAME applies only to APPC logical units; for other types, the value returned is blanks.
MSRCONTROLST(cvda)
returns a CVDA value indicating whether the terminal has a magnetic slot reader. This feature is available only on 8775 and 3643 terminals. CVDA values are:
MSRCONTROL
The terminal has a magnetic slot reader.
NOMSRCONTROL
The terminal does not have a magnetic slot reader.
NATLANG(data-area)
returns a 1-character value giving the national language specified in the terminal definition. This value cannot be changed by any command, and is not necessarily the same as the national language currently in use at the terminal. To determine current language, see the NATLANGINUSE option of the ASSIGN command in the CICS Application Programming Reference manual. Possible values are listed in the CICS RACF® Security Guide. A blank means that no value has been specified.
NATURE(cvda)
returns a CVDA value identifying the nature of the terminal definition. CVDA values are:
MODEL
A remote terminal definition (representing a terminal owned by another CICS region) which is not currently expanded into a surrogate.
REMSESSION
A remote session.
SESSION
A session.
SURROGATE
A remote terminal definition (representing a terminal owned by another CICS region) which is expanded into a surrogate.
TERMINAL
A physical terminal definition.
NETNAME(data-area)
returns the 8-character network name of the terminal about which you are inquiring.

For a physical terminal, this is the name by which this terminal is known to VTAM. For ISC sessions, it is the name by which the session (or session group, if there are parallel sessions) is known to VTAM. For MRO sessions, it is the name used by the connected region to log on to the interregion communication program. For a remote terminal, it is the name by which the terminal is known to the VTAM in the remote region. (For a remote terminal routed from a pre-CICS Transaction Server for z/OS region, NETNAME is blank.)

If the netname is a VTAM LU alias, it is different from the netname component of the NQNAME, which always contains the real netname.

Note:
The description above applies to the NETNAME option in an INQUIRE TERMINAL command. In an INQUIRE NETNAME command, the roles of NETNAME and TERMINAL are reversed. NETNAME specifies the name of the terminal or session about which you are inquiring to CICS, rather than returning information, and TERMINAL returns the corresponding terminal identifier if you use it. See the description of INQUIRE NETNAME in topic INQUIRE NETNAME.
NEXTTRANSID(data-area)
returns the 4-character identifier of the transaction to be executed to process the next unsolicited input from this terminal. This value comes from the TRANSACTION value in the TERMINAL or SESSIONS definition, if one has been specified. If the value has not been specified, it was set by the previous task for which the terminal was principal facility (in the TRANSID option of its final RETURN command) and is blanks if that task did not specify a value or if an active task has the terminal as principal facility.
NQNAME(data-area)
returns the 17-character network-qualified name for any terminal that received an NQNAME from VTAM at logon time.

This applies to local terminals only--remote terminals do not have a network-qualified name.

NQNAME, which is supported for problem determination purposes only, is returned for both autoinstalled and RDO-defined resources if it has been supplied by VTAM. However, it is not catalogued for RDO-defined resources and is therefore not available on a restart until that resource logs on again.

If the resource is non-VTAM or a remote terminal, NQNAME is blank. If the resource is a VTAM resource but has not yet received an NQNAME, CICS returns the known netname.

OBFORMATST(cvda)
returns a CVDA value indicating whether outboard formatting can be used for this terminal. CVDA values are:
NOOBFORMAT
This terminal does not support outboard formatting.
OBFORMAT
This terminal supports outboard formatting.
OBOPERIDST(cvda)
returns a CVDA value indicating whether CICS uses outboard operator identifiers to support the BMS routing facilities at this terminal. This option only applies to the 3790 and 3770 batch data interchange logical units. CVDA values are:
NOOBOPERID
CICS does not use outboard operator identifiers.
OBOPERID
CICS uses outboard operator identifiers.
OPERID(data-area)
returns the 3-character operator identification code of the user signed on at the terminal.
Note:
If the terminal is a surrogate terminal, this value may not be current; it represents the user signed on at the time the terminal definition was shipped from the owning CICS region to this one, who may since have signed off. For information, see the CICS RACF Security Guide. The OPERID may also be different from that of the user currently signed on if it has been changed with the SET TERMINAL command.
OUTLINEST(cvda)
returns a CVDA value indicating whether the terminal has the 3270 field outlining feature. CVDA values are:
NOOUTLINE
The terminal does not support field outlining. (This value is always returned for a model terminal.)
OUTLINE
The terminal supports field outlining.
PAGEHT(data-area)
returns a halfword binary field giving the height (in lines) of the current page size for the terminal. See the DEFPAGEHT and ALTPAGEHT options.
PAGESTATUS(cvda)
returns a CVDA value indicating how pages of BMS messages with a disposition of PAGING should be delivered to the terminal. CVDA values are:
AUTOPAGEABLE
Pages are written automatically in sequence.
PAGEABLE
Pages are written on request from the operator.
PAGEWD(cvda)
returns a halfword binary field giving the width (in characters) of the current page size for the terminal. See also the DEFPAGEWD and ALTPAGEWD options.
PARTITIONSST(cvda)
returns a CVDA value indicating whether the terminal supports partitions. CVDA values are:
NOPARTITIONS
The terminal does not support partitions.
PARTITIONS
The terminal supports partitions.
PRINTADAPTST(cvda)
returns a CVDA value indicating whether the terminal has the printer adapter feature. CVDA values are:
NOPRINTADAPT
The terminal does not have a printer adapter.
PRINTADAPT
The terminal has a printer adapter.
PRINTER(data-area)
returns the 4-character name of the preferred printer for print key requests and ISSUE PRINT commands from tasks at this terminal. This printer is used if available; if not, the printer named in the ALTPRINTER option is second choice.
PROGSYMBOLST(cvda)
returns a CVDA value indicating whether the terminal supports the 3270 programmed symbol feature, which enables the terminal to use multiple character sets. CVDA values are:
NOPROGSYMBOL
The terminal does not support programmable symbols.
PROGSYMBOL
The terminal supports programmable symbols.
PRTCOPYST(cvda)
returns a CVDA value indicating whether CICS is to use the hardware copy feature to satisfy a print request on the printer named on the PRINTER option. CVDA values are:
NOPRTCOPY
CICS is not to use the hardware copy feature.
NOTAPPLIC
The terminal is not a VTAM terminal, or is a remote terminal, a surrogate terminal, or a model definition.
PRTCOPY
CICS is to use the hardware copy feature.
QUERYST(cvda)
returns a CVDA value indicating whether and when CICS should use a QUERY structured field to determine the characteristics of the terminal.
ALLQUERY
The terminal is to be queried each time it is connected.
COLDQUERY
The terminal is to be queried only when it is first connected after an initial or cold start of CICS. The device characteristics are stored on the global catalog for use on subsequent warm and emergency starts.
NOQUERY
The terminal is not to be queried.
RELREQST(cvda) (VTAM only)
returns a CVDA value indicating whether CICS is to honor requests from VTAM to release the terminal or session. CVDA values are:
NORELREQ
CICS cannot release the logical unit, or the access method is not VTAM.
RELREQ
CICS can release the logical unit.
REMOTENAME(data-area)
returns the 4-character name of this terminal in the remote CICS region in which it is defined. REMOTENAME applies only to terminals defined as remote; for others the value returned is blanks.
REMOTESYSNET(data-area)
returns the 8-character netname of the owning TOR, if the subject of this inquiry is a remote terminal. If it is blank, but the terminal is remote, the system named in the REMOTESYSTEM field has not been installed, and no value was specified for the REMOTESYSNET option when the terminal was defined.
REMOTESYSTEM(data-area)
returns the 4-character name of a connection, if the subject of the inquiry is a remote terminal. The named connection can be either a connection entry that links towards the TOR, or an indirect connection that provides the netname of the TOR.

Otherwise this field is blank.

SCRNHT(data-area) (or SCREENHEIGHT)
returns a halfword binary field giving the height (in lines) of the current screen size. See also the DEFSCRNHT and ALTSCRNHT options.
Note:
SCRNHT is a synonym for the SCREENHEIGHT option of earlier releases of CICS. For compatibility, CICS recognizes SCREENHEIGHT as equivalent.
SCRNWD(data-area) (or SCREENWIDTH)
returns a halfword binary field giving the current width of the terminal screen (in characters). See the DEFSCRNWD and ALTSCRNWD options.
Note:
SCRNWD is a synonym for the SCREENWIDTH option of earlier releases of CICS. For compatibility, CICS recognizes SCREENWIDTH as equivalent.
SECURITY(cvda)
returns a CVDA value indicating whether the terminal has preset security; that is, whether a USERID value has been specified in the TERMINAL or SESSIONS definition, so that it is permanently signed on. CVDA values are:
NOPRESETSEC
The terminal does not have preset security.
PRESETSEC
The terminal has preset security.
SERVSTATUS(cvda)
returns a CVDA value indicating whether the terminal is available for use (from the point of view of the local CICS system, which may be different from the system which owns the terminal). SERVSTATUS corresponds to the INSERVICE option in the TERMINAL definition. "Available" (INSERVICE) does not necessarily imply, for a VTAM terminal, that the terminal is acquired.
GOINGOUT
The terminal is put in OUTSERVICE status as soon as some current work has completed and is not available to new tasks.
INSERVICE
The terminal is available.
OUTSERVICE
The terminal is not available.
SESSIONTYPE(cvda)
returns a CVDA value identifying the type of the session about which you are inquiring. This option applies only to VTAM sessions. CVDA values are:
APPCPARALLEL
This is a parallel APPC session group.
APPCSINGLE
This is a single APPC session.
LU61
This is an LUTYPE6.1 session.
NOTAPPLIC
The terminal is not one of the above.
SIGNONSTATUS(cvda)
returns a CVDA value identifying whether the terminal currently has a signed-on user. CVDA values are:
SIGNEDOFF
The terminal does not have a signed-on user.
SIGNEDON
The terminal has a signed-on user.
SOSIST(cvda)
returns a CVDA value indicating whether the terminal supports mixed EBCDIC and double-byte character set (DBCS) fields. CVDA values are:
NOSOSI
The terminal does not support mixed fields.
SOSI
The terminal supports mixed fields.
TASKID(data-area)
returns a fullword binary field giving the number of the user task currently executing at this terminal. Zero is returned if no task is using the terminal.
TCAMCONTROL(data-area) (TCAM only)
returns a 1-character TCAM control byte giving one of the following codes to identify which segment of a message has passed between CICS and TCAM.

The meanings are:

00
Null
40
Intermediate part of message
F1
First part of message
F2
Last part of message
F3
Whole message
F4
Intermediate part of message, end of record
F5
First part of message, end of record
F6
Last part of message, end of record
F7
Whole message, end of record
FE
TCAM is not active
FF
Not applicable (non-TCAM terminal)
TERMINAL(data-value)
specifies the 4-character name of the terminal or session about which you are inquiring, in an INQUIRE TERMINAL command. In an INQUIRE NETNAME command, this option returns the terminal identifier that corresponds to the NETNAME value you specified. See the NETNAME option and the general information for this command.
TERMMODEL(data-area)
returns a halfword binary field giving the terminal model number.
TERMPRIORITY(data-area)
returns a fullword binary field giving the priority of the terminal relative to other terminals, in the range 0-255.
TERMSTATUS(cvda) (VTAM only)
returns a CVDA value indicating whether CICS is in session with the logical unit represented by this terminal. CVDA values are:
ACQUIRED
CICS is in session with the logical unit.
ACQUIRING
The session is in the process of being acquired.
NOTAPPLIC
The terminal is not a VTAM terminal.
RELEASED
CICS is not in session with the logical unit.
RELEASING
The session is in the process of being released.
TEXTKYBDST(cvda)
returns a CVDA value indicating whether the terminal has the 3270 text-keyboard feature. CVDA values are:
NOTEXTKYBD
The terminal does not have the text-keyboard feature.
TEXTKYBD
The terminal has the text-keyboard feature.
TEXTPRINTST(cvda)
returns a CVDA value indicating whether the terminal has the 3288 text-print feature. CVDA values are:
NOTEXTPRINT
The terminal does not have the text-print feature.
TEXTPRINT
The terminal has the text-print feature.
TRACING(cvda)
returns a CVDA value indicating the type of tracing defined for this terminal. CVDA values are:
SPECTRACE
Special tracing is specified.
STANTRACE
Standard tracing is specified.

For a task that has this terminal as its principal facility, this value is combined with the TRACING option value of the transaction the task is executing to determine whether tracing is standard, special, or suppressed.

If the transaction TRACING value is SUPPRESSED, no tracing occurs. Otherwise, tracing is special if either the terminal or the transaction specifies SPECTRACE, standard if both specify STANTRACE.

A TRACING value of STANTRACE is assigned when the terminal is defined. You can specify SPECTRACE only with a SET TERMINAL command or the CICS-supplied CETR transaction.

TRANSACTION(data-area)
returns the 4-character identifier of the transaction being executed by the task for which this terminal is the principal facility. Blanks are returned if no task is currently running at the terminal.
TTISTATUS(cvda)
returns a CVDA value indicating whether this terminal can initiate tasks by entering unsolicited input. CVDA values are:
NOTTI
This terminal cannot initiate transactions.
TTI
This terminal can initiate transactions.
UCTRANST(cvda)
returns a CVDA value indicating whether input from this terminal is translated to uppercase automatically, at the time of receipt. (Translation can be suppressed, but only in a conversational task, when input is solicited with a RECEIVE or CONVERSE ASIS command.) This value comes from the UCTRAN option of the TYPETERM definition associated with the terminal; there is also a UCTRAN option in a PROFILE definition, but that value is not pertinent here. CVDA values are:
NOUCTRAN
Input from this terminal is not translated to uppercase on receipt. (It is translated before presentation to the task issuing a RECEIVE, however, if the PROFILE definition for the transaction being executed specifies translation. See Table 6 for information on how the UCTRAN options on the terminal and transaction profiles interact.)
TRANIDONLY
This value is the same as NOUCTRAN, with one difference. If the input is unsolicited, and CICS needs to use the initial characters of the input to decide which transaction to execute, that decision is made from a copy of the input which has been translated to uppercase. There is no difference in the data presented to the task between these two options.
UCTRAN
The input is translated to uppercase on receipt. (It is unaffected by the translation option in the PROFILE).
USERAREA(ptr-ref)
returns the address of the terminal control table user area (TCTUA) for this terminal. If there is no TCTUA, the address returned is X'FF000000'.
USERAREALEN(data-area)
returns a halfword binary field giving the length of the user area. Zero is returned if there is no user area.
USERID(data-area)
returns the 8-character identifier of the user signed on at this terminal or session.

If there is no signed-on user, the default user ID--as specified in the DFLTUSER system initialization parameter--is returned.

USERNAME(data-area)
returns the 20-character name of the user signed on at this terminal or session (that is, the name corresponding to the USERID option value). If the information, which is provided by the external security manager, is shorter than 20 bytes, CICS pads it to 20 with trailing blanks. Blanks are returned if there is no signed on user.
VALIDATIONST(cvda)
returns a CVDA value identifying whether the device has the extended validation feature, which allows you to request special processing of keyboard input, additional to normal 3270 function. This feature is available only on 8775 and 3290 terminals. CVDA values are:
NOVALIDATION
The terminal does not have the extended validation feature or is a model terminal.
VALIDATION
The terminal has the extended validation feature.
VFORMST(cvda)
returns a CVDA value indicating whether the terminal has the vertical forms feature, which is required for use of vertical tabbing when formatting documents for output. CVDA values are:
NOVFORM
The device does not have the vertical forms feature.
VFORM
The terminal has the vertical forms feature.
ZCPTRACING(cvda) (VTAM only)
returns a CVDA value indicating whether this terminal is traced when CICS tracing for VTAM terminals is turned on. CVDA values are:
NOTAPPLIC
The terminal is not a VTAM terminal, or is a surrogate terminal or a model definition.
NOZCPTRACE
The terminal will not be traced.
ZCPTRACE
The terminal is traced.

Conditions

END
RESP2 values:
2
There are no more resource definitions of this type.
ILLOGIC
RESP2 values:
1
You have issued a START command when a browse of this resource type is already in progress, or you have issued a NEXT or an END command when a browse of this resource type is not in progress.
NOTAUTH
RESP2 values:
100
The user associated with the issuing task is not authorized to use this command.
TERMIDERR
RESP2 values:
1
The named terminal cannot be found.
[[ Contents Previous Page | Next Page Index ]]