USERVAR parameters

When VTAM® calls the exit for invoke processing, it passes the address of certain parameters to the exit in register 1. There is one set of parameters for when the USERVAR is to be added, updated, or deleted, and another set of parameters for when a USERVAR is to be translated.

The address of the following parameters is passed to the USERVAR exit routine in the USERVAR exit parameter list when a USERVAR is to be added, updated, or deleted.

Table 1. USERVAR parameters for USERVAR addition, update, or deletion
Dec (Hex) offset	Size (Bytes)	Description
0 (0)	8	USERVAR name
8 (8)	8	USERVAR value
16 (10)	8	Reserved

The address of the following parameters is passed to the USERVAR exit routine in the USERVAR exit parameter list when a USERVAR is to be translated.

Table 2. USERVAR parameters for USERVAR translation
Dec (Hex) offset	Size (Bytes)	Description
0 (0)	8	OLU name
8 (8)	4	OLU subarea address in the DLU network
12 (C)	4	Address of the session partners list (see Table 1)
16 (10)	8	CoS name for the session
24 (18)	8	Generic DLU name
32 (20)	1	Flags B'10.. ....' The OLU is the SLU. B'01.. ....' The OLU is the PLU. B'..1. ....' The USERVAR name was translated. B'..0. ....' The USERVAR name was not translated. B'...1 0...' The USERVAR is static. B'...0 1...' The USERVAR is dynamic. B'...1 1...' The USERVAR is volatile. B'.... .1..' In the OLU domain. B'.... ..1.' Network ID specified in the request. The remaining bit is reserved.
33 (21)	3	Reserved
36 (24)	8	USERVAR value
44 (2C)	8	Reserved

If the translation flag indicates the name was not translated, VTAM considers the USERVAR to be unresolved and continues processing as though the USERVAR exit had not been invoked.

If the translation flag indicates the name was translated, VTAM uses the USERVAR value returned by the exit and continues processing. For a dynamic or static USERVAR, VTAM updates the USERVAR table and uses the USERVAR value returned by the exit as though the value were retrieved from the USERVAR table without the intervention of the exit. For a volatile USERVAR, VTAM establishes the session with the USERVAR value without updating the USERVAR table.