Previous Topic: Predefined VariablesNext Topic: Return Codes


Predefined Function Variables

The following table lists the ACL/E predefined variables that are functions that return information about a user-specified session or application.

Variable

Function

&APPL_INF(applID)

This variable provides information about the specified application. The variable can return one or more of the following values:

ACTIVE—Indicates that the application is defined and is accepting logons.

INACT—Indicates that the application is defined but is not accepting logon.

QUIESCED—Indicates that the application has one or more active sessions. New sessions will not be started.

TYPE=TPX—Indicates that the application is an internal application such as TPXMAIL or TPXVIEW.

UNDEFINED—Indicates that the application is not defined to CA TPX.

&MSIZE_OF(string)

This variable represents the maximum possible length of the specified string after variables in the string have been substituted.

&SESS_INF(sessionID)

This variable represents information about the specified session. It can return one or more of the following values:

ACTIVE—Indicates that the session is currently active.

ACL=program—Indicates that the session is active and the specified ACL/E program is running in the session.

APPL=appl—Indicates that the specified application is running the session.

CURRENT—Indicates that the session is the user's current session.

INACT—Indicates that the session is not currently active, although it has been active during the user's current session with CA TPX.

 

NEVACT—Indicates that the session has never been active during the user's current session with CA TPX.

UNDEFINED—The specified session is not a valid session name.

&SIZE_OF(string)

This variable represents the length of the specified string after all variables in that string have been substituted.

&TYPE_OF(variable)

This variable represents the specified variable's type. This variable can return one or more of the following values:

ACL—Indicates that the variable was defined in ACL/E.

ARRAY—Indicates that this is an array variable.

BIN—Indicates that this is a binary variable.

CHAR—Indicates that this is a character variable.

HEX—Indicates that this is a hexadecimal variable.

NOTRUNC—Indicates that the variable will not be stripped of trailing blanks when substitution takes place.

NUM—Indicates that this is a numeric variable.

UNDEFINED—Indicates that the variable is not defined.

UPCHAR—Indicates that this is an uppercase character variable.