PASS

Edit online

Performs a CLSDST PASS of a logical unit (LU) from a dialog to a destination application.

Type

Dialog Language function

Format

PASS(destination [logmode] [userdata] [simlogon] ['QSESSLIM'])
destination
The destination name. It can be any valid string expression that resolves to a valid destination name. The Dialog Manager passes the LU to this destination.
logmode
The logmode used when establishing the session. It can be any valid string expression that resolves to a valid logmode.
userdata
The user data passed with the logon request. It can be any valid string expression.
simlogon
The user data passed with a SIMLOGON OPTCD=Q command. It can be any valid string expression or resolve to nulls. The Dialog Manager issues the command on behalf of the LU being passed. simlogon can be used to cause the physical session to be queued back to the gateway. When the passed session is terminated, the user is sent back to the gateway.
'QSESSLIM'
Only valid with SIMLOGON, QSESSLIM specifies OPTCD=(Q,QSESSLIM) for the SIMLOGON request. The queued secondary logon will only be honored if the secondary logical unit is at its session limit. If this operand is omitted, then the default is OPTCD=(Q,QALL). This is useful for network users that use pools of terminals (typically LANs). If such a terminal becomes deactivated, it may be used by another network user who will receive the queued logon. Use of the QSESSLIM option will dequeue the SIMLOGON if the terminal is not enabled.

Return Codes

0
PASS completed successfully.
¬0
A 16-character string indicating the reason for the failure:
f
Failure type flag:
4
CLSDST PASS failed, rc and rs fields valid.
2
Session setup failed, ssssssss field valid.
zzz
Always zeros (000).
rc
RPL return code from CLSDST failure.
rs
RPL reason code from CLSDST failure.
ssssssssss
Sense code causing pass reject (for example, 08210000 for bad logmode).

Usage Notes®

  1. A null destination causes the dialog to be failed.
  2. If a null logmode is specified, VTAM® will use the default associated with destination.
  3. Any specification of simlogon, even nulls (''), causes a SIMLOGON.
  4. A null simlogon queues a session without user data.
  5. When a PASS fails, CL/SuperSession tries to reacquire the physical terminal session and continue the dialog. If the terminal is no longer available (for example, when a line drops), message KLVDF061 is written to TLVLOG and the physical session terminates as if a logoff had been performed.

Example

In the following example, control is passed to the VTAM application TSO using DefLMode as logmode, passing VIGUser as user data, and doing a simlogon back to the originating HOSTGATE or dialog ACB:
pass('TSO' &DefLMode &VIGUser '&VIGUser &VIGPswd')