Previous Topic: Predefined VariablesNext Topic: Predefined Function Variables


Predefined Variables

The following table lists the ACL/E predefined variables that do not require an operand.

Variable

Function

&An

This variable represents any of four accumulators, &A1 through &A4, which can contain any positive integer from 0 through 16,777,215 (16M-1). Accumulators can be set, added into, subtracted from, and compared against other values, or included in any string as &An (where n equals 1, 2, 3, or 4).

When used in a string this way (for example, 487&A1.ABC), the value of &A1 is substituted into the string before the statement is executed. For instance, if &A1=333 in the last example, the value of the string would be 487333ABC.

&AID

This variable represents the attention identifier byte from the last action taken.

&APPL

This variable represents the VTAM APPLID of the session in which the ACL/E is running.

&APPLID

This variable represents the VTAM APPLID of the session in which the ACL/E is running. For applications that issue CLSDST PASS, such as TSO, this variable can have a different value than &APPL.

&CSRCOL

This variable represents the column value of the &CURSOR variable.

&CSRROW

This variable represents the row value of the &CURSOR variable.

&CURSOR

This variable represents the current cursor location as a screen position. Row 1, Column 1 is position 1. On an 80 by 24 display, Row 2, Column 1 is position 81, and so on. Use of &CURSOR as the receiving field of a SET command causes cursor movement within the current screen image.

&ERR_MSG

This variable contains the text of the error message that occurred during ACL/E processing, and is set when you use the ERROR operand on the OPTION command.

&ERR_RC

This variable contains the return code of the error that occurred during ACL/E processing, and is set when you use the ERROR operand on the OPTION command.

&IPADDR

This variable represents either an IPv4 or IPv6 TCP/IP address. If this is an IPv4 address, it will be represented as a 4 octet address. If this is an IPv6 address, it will be represented as an 8, 16 bit, hexadecimal value address.

&IPPORT

This variable represents the 1 to 4 byte TCP/IP port number of the terminal connection, in decimal. Leading zeroes are suppressed.

&IPVECT

This variable represents the entire TCP/IP vector (x'64') from the CINIT.

&LOC

This variable represents a data location as a screen position. Row 1, column 1 is position 1. The SEARCH command sets &LOC to the screen position of the first byte of data that satisfies an equal condition.

&LOC is used to determine the current field location for &SCRNFLD and for SEARCHF.

&LOCCOL

This variable contains the column value of the &LOC variable.

&LOCROW

This variable contains the row value of the &LOC variable.

&NETNAME

This variable represents the VTAM network name of the physical terminal where the current application session is active.

&NPSWD

This variable represents the new password the user defined after signing on. If the user kept the initial password, CA TPX assigns a value of two question marks (??) to this variable.

&NPWPH

This variable represents the new password phrase the user defined after signing on. If the user kept the initial password phrase, CA TPX assigns a value of two question marks (??) to this variable.

&OPSWD

This variable represents the password that the user initially employed when signing on to CA TPX.

&OPWPH

This variable represents the password phrase that the user initially employed when signing on to CA TPX.

&Pn

These variables, &P1 through &P8, represent the respective items in the PARM parameter statement associated with this session, through User or Profile Maintenance. You also can use these variables as string variables or even as return codes by setting them as desired. As with all variables, you can include &Pn variables within a string, and their values will be substituted before the statement is executed.

&P0 has a special meaning. When you start an ACL/E program with the /S command, you can enter text to the right of the ACL/E program name. This text will become &P0 within the program. For example:

/S ACCTACL DEPARTMENT A

&P0 was given the value DEPARTMENT A.

If &P variables are unused, they have a value of eight question marks.

&PRINTER

This is the eight-character name of the default printer for the owner of the session in which the ACL/E is running.

&PSWD

This variable represents the current password for the user.

CA TPX assigns a value of two question marks (??) if "NONE" is specified in the "Security System" field in user maintenance.

&PWPH

This variable represents the current password phrase for the user.

CA TPX assigns a value of two question marks (??) if "NONE" is specified in the "Security System" field in user maintenance.

&SCREEN

This variable represents the entire screen image. It is usually used with substring notation to limit the amount of data involved.

&SCRNCOLS

This is the number of columns on the terminal screen.

&SCRNFLD

This variable represents the data from &LOC to the end of the current field.

&SCRNROWS

This is the number of rows on the terminal screen.

&SCRNSIZE

This is the absolute screen size, in bytes. For example, 80 columns by 24 rows gives &SCRNSIZE a value of 1920.

&SID

This variable represents the session ID of the current session.

&TAID

This is the last AID (attention identifier) byte received from the terminal in response to the last ACL/E INPUT command.

&TAID defaults to ENTER if no INPUT command has been issued. You can use the SET command to assign any valid AID value (PF1-24, CLEAR, PA1-3, or ENTER) to &TAID prior to issuing a SEND command.

&TCSRCOL

This variable represents the column value of &TCURSOR.

&TCSRROW

This variable represents the row value of &TCURSOR.

&TCURSOR

This variable represents the current cursor location of the alternate screen image as a screen position. Row 1, column 1 is position 1. On an 80 by 24 display, row 2,column 1 is position 81, and so on.

&USERID

This variable represents either the user's signon ID or the value specified in the "ACL Userid" field in User or Profile Maintenance.

&VTERM

This variable represents the name of the virtual terminal associated with the session.

&ZAPPLID

This variable represents the VTAM name (applid) of the current CA TPX.

&ZCONN

This variable represents the session ID of the currently connected session (the session currently being displayed on the terminal).

&ZDATE

This variable represents the U.S. format date (mm/dd/yy).

&ZEDATE

This variable represents the European format date (dd/mm/yy).

&ZJDATE

This variable represents the Julian format date (yyddd).

&ZLDATE

This variable represents the U.S. long format date (mm/dd/yyyy).

&ZLEDATE

This variable represents the European long format date (dd/mm/yyyy).

&ZLJDATE

This variable represents the Julian long format date (yyyyddd).

&ZMODEL

This variable represents the terminal model type (for example, 3278-2).

&ZNEWS1

This variable is used on the LOGO panel for distributing a brief message to users.

&ZNEWS2

This variable is used on the LOGO panel for distributing a brief message to users.

&ZSMFID

This variable represents the SMF ID of the z/OS system running CA TPX. This is a system parameter for GCS.

&ZSYSID

This variable represents the name of the System Options Table (SMRT) currently in use by CA TPX.

&ZTIME

This variable represents the current time.

&ZTERMID

This variable represents VTAM Terminal ID.