INQUIRE TERMINAL

Description

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

Some of the options in this command return system status information, such as whether the terminal is acquired or not or whether it is in use by a task. 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 might have been autoinstalled. For a session, the CONNECTION defines shared properties and SESSIONS defines specifics.

In most cases, options of this type have the same name as the option (or a name that is similar name) to 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 be 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.

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. Here are the CVDA values:

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.

VTAM®

The access method is z/OS® Communications Server.

ACQSTATUS(cvda) (z/OS Communications Server only)

Returns the same value as the TERMSTATUS option and is retained only for compatibility purposes. Use TERMSTATUS in new applications.

AIDCOUNT(data-area)

Returns a fullword binary field giving the number of automatic initiate descriptors (AIDs) queued for the specified terminal. If there are no AIDs, then an AIDCOUNT value of 0 is returned.

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. Here are the CVDA values:

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 z/OS Communications Server 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 field is a character field and, in that context, null refers to the blank character x'40'.

APLKYBDST(cvda)

Returns a CVDA value indicating whether the terminal has the APL keyboard feature. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

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 attempts to establish (bind) a session with this terminal when communication with z/OS Communications Server is established. Here are the CVDA values:

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 z/OS Communications Server 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. Here are the CVDA values:

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. Here are the CVDA values:

COLOR

The terminal has the extended color feature.

NOCOLOR

The terminal does not have the extended color feature.

CONSOLE(data-area)

Returns, 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.

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. Here are the CVDA values:

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 set differently depending on the session:

• 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) (z/OS Communications Server only)

Returns a CVDA value indicating whether CICS attempts to acquire the terminal if it is required for an automatic task initiation (ATI) request. Only z/OS Communications Server physical terminals can be acquired by CICS; sessions are not eligible. Here are the CVDA values:

CREATE

The terminal can be acquired.

NOCREATE

The terminal cannot be acquired.

NOTAPPLIC

The terminal is not a z/OS Communications Server 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. Here are the CVDA values:

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. The CVDA values are as follows:

DISCREQ

CICS will honor a request to disconnect this terminal, with a z/OS Communications Server CLSDST request to end the session if the terminal is a z/OS Communications Server terminal.

NODISCREQ

CICS will not honor a request to disconnect this terminal.

NOTAPPLIC

The option does not apply to this terminal.

DUALCASEST(cvda)

Returns a CVDA value indicating whether the terminal has a typewriter keyboard or an operator console keyboard. Here are the CVDA values:

DUALCASE

The terminal has a typewriter keyboard.

NODUALCASE

The terminal has an operator console keyboard or is not a 3270 display.

EXITTRACING(cvda) (z/OS Communications Server only)

Returns a CVDA value indicating whether this terminal is traced when CICS z/OS Communications Server exit tracing is active. See the TCEXITSTATUS option in the INQUIRE TRACEFLAG command. Here are the CVDA values:

EXITTRACE

The terminal is traced.

NOEXITTRACE

The terminal will not be traced.

NOTAPPLIC

The terminal is not a z/OS Communications Server 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. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

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 used as 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. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

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 might 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 might 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, might 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 can be suffixed by a terminal or alternate suffix. If this terminal is a surrogate, the mapset name might 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.

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. Here are the CVDA values:

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. Possible values are listed in National language codes. A blank means that no value has been specified.

NATURE(cvda)

Returns a CVDA value identifying the nature of the terminal definition. Here are the CVDA values:

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 name is the one by which this terminal is known to z/OS Communications Server. For ISC sessions, it is the name by which the session or session group, if there are parallel sessions, is known to z/OS Communications Server. 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 z/OS Communications Server in the remote region.

If the netname is a z/OS Communications Server LU alias, it is different from the netname component of the NQNAME, which always contains the real netname.

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.

NEXTTRANSID(data-area)

Returns the 4-character identifier of the transaction to be run 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 z/OS Communications Server at logon time.

This name 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 z/OS Communications Server. 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-z/OS Communications Server or a remote terminal, NQNAME is blank. If the resource is a z/OS Communications Server 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. Here are the CVDA values:

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 applies only to the 3790 and 3770 batch data interchange logical units. Here are the CVDA values:

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.

If the terminal is a surrogate terminal, this value might 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 and, who might have signed off. The OPERID might 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. Here are the CVDA values:

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 will be delivered to the terminal. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

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. Here are the CVDA values:

NOPRTCOPY

CICS is not to use the hardware copy feature.

NOTAPPLIC

The terminal is not a z/OS Communications Server 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 will use a QUERY structured field to determine the characteristics of the terminal. Here are the CVDA values:

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) (z/OS Communications Server only)

Returns a CVDA value indicating whether CICS is to honor requests from z/OS Communications Server to release the terminal or session. Here are the CVDA values:

NORELREQ

CICS cannot release the logical unit, or the access method is not z/OS Communications Server.

RELREQ

CICS can release the logical unit.

NOTAPPLIC

The option does not apply to this terminal.

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 first four characters 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.

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.

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. Here are the CVDA values:

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 might be different from the system that owns the terminal. SERVSTATUS corresponds to the INSERVICE option in the TERMINAL definition. Available (INSERVICE) does not necessarily imply, for a z/OS Communications Server terminal, that the terminal is acquired. Here are the CVDA values:

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 z/OS Communications Server sessions. Here are the CVDA values:

APPCPARALLEL

A parallel APPC session group.

APPCSINGLE

A single APPC session.

LU61

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. Here are the CVDA values:

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. Here are the CVDA values:

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 running at this terminal. Zero is returned if no task is using the terminal.

TCAMCONTROL(data-area)

Obsolete. TCAM terminals are not supported.

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) (z/OS Communications Server only)

Returns a CVDA value indicating whether CICS is in session with the logical unit represented by this terminal. Here are the CVDA values:

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 z/OS Communications Server 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. Here are the CVDA values:

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. Here are the CVDA values:

NOTEXTPRINT

The terminal does not have the text-print feature.

TEXTPRINT

The terminal has the text-print feature.

TNADDR(data-area)

Returns, in a 39-character area, the IPv4 or IPv6 address of the TN3270 client. If TNIPFAMILY returns NOTAPPLIC, TNADDR returns blanks.

TNIPFAMILY(cvda)

Returns the address format of the TNADDR option. The CVDA values are as follows:

NOTAPPLIC

This value indicates one of the following conditions:

• The terminal is not a 3270 device.
• TNADDR is not used.
• The address cannot be resolved.

IPV4

The TNADDR option contains an IPv4 dotted decimal address.

IPV6

The TNADDR option contains an IPv6 colon hexadecimal address.

TNPORT(data-area)

Returns a fullword binary value containing the port number that is used for the TN3270 client connection. If the terminal is not a 3270 device, TNPORT returns zero.

TRACING(cvda)

Returns a CVDA value indicating the type of tracing defined for this terminal. Here are the CVDA values:

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. Here are the CVDA values:

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 characters 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. The PROFILE definition also has a UCTRAN option, but that value is not relevant here. Here are the CVDA values:

NOUCTRAN

Input from this terminal is not translated to uppercase characters on receipt. It is translated before presentation to the task issuing a RECEIVE, however, if the PROFILE definition for the transaction being run specifies translation. See the information about the effect of the UCTRAN parameters in SET TERMINAL to learn 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 run, that decision is made from a copy of the input that has been translated to uppercase characters. The data presented to the task is the same for both.

UCTRAN

The input is translated to uppercase characters 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 no user is signed on, 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 no user is signed on.

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, in addition to normal 3270 function. This feature is available only on 8775 and 3290 terminals. Here are the CVDA values:

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. Here are the CVDA values:

NOVFORM

The device does not have the vertical forms feature.

VFORM

The terminal has the vertical forms feature.

ZCPTRACING(cvda) (z/OS Communications Server only)

Returns a CVDA value indicating whether this terminal is traced when CICS tracing for z/OS Communications Server terminals is turned on. Here are the CVDA values:

NOTAPPLIC

The terminal is not a z/OS Communications Server terminal, or is a surrogate terminal or a model definition.

NOZCPTRACE

The terminal is not traced.

ZCPTRACE

The terminal is traced.

Conditions

END

RESP2 value:

2

There are no more resource definitions of this type.

ILLOGIC

RESP2 value:

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 value:

100

The user associated with the issuing task is not authorized to use this command.

TERMIDERR

RESP2 value:

1

The named terminal cannot be found.