User ID Routine - IBM-REXX

The user ID routine returns the same value as the USERID built-in function.The system calls the user ID replaceable routine whenever the USERID built-in function is issued in a language processor environment that is not integrated into TSO/E. The routine then returns either the user ID, stepname, or jobname. The name of the system-supplied user ID routine is IRXUID.

The name of the user ID replaceable routine is specified in the IDROUT field in the module name table.

Entry Specifications

For the user ID replaceable routine, the contents of the registers on entry are described below. The address of the environment block can be specified in either register 0 or in the environment block address parameter in the parameter list.

Register 0 Address of the current environment block

Register 1 Address of the parameter list

Registers 2-12 Unpredictable

Register 13 Address of a register save area

Register 14 Return address

Register 15 Entry point address

Parameters

Register 1 contains the address of a parameter list, which consists of a list of addresses. Each address in the parameter list points to a parameter. The high-order bit of the last address in the parameter list must be set to 1 to indicate the end of the parameter list.

The describes the parameters for the user ID routine.

Parameters for the User ID Replaceable Routine

Parameters for the User ID Replaceable Routine

Functions Supported for the User ID Routine

The function to be performed by the user ID routine is specified in parameter 1. The valid functions are described below.

USERID
Returns the same value that the USERID built-in function would return in an environment that is not integrated into TSO/E. The value returned may be a user ID, a stepname, or a jobname. You can use the USERID function only in environments that are not integrated into TSO/E.

TSOID
Returns the same value that the USERID built-in function would return in an environment that is integrated into TSO/E. The value returned is the TSO/E user ID.You can use the TSOID function only in a TSO/E address space in an environment that is integrated into TSO/E.

The TSOID function is intended for use if an application program calls the user ID routine, IRXUID, in a language processor environment that is integrated into TSO/E to obtain the user ID. You can also use the TSOID function if you write your own user ID routine and then call your routine from application programs running in environments that are integrated into TSO/E.

TSOID is intended only for language processor environments that are integrated into TSO/E. Because you can replace the user ID routine only inenvironments that are not integrated into TSO/E, your replaceable routine does not have to support the TSOID function.

Return Specifications

For the user ID replaceable routine, the contents of the registers on return are:

Registers 0-14 Same as on entry

Register 15 Return code

Return Codes

This shows the return codes for the user ID routine. The routine returns the return code in register 15. If you specify the return code parameter (parameter 5), the user ID routine also returns the return code in the parameter.

Return Codes for the User ID Replaceable Routine

Return Codes for the User ID Replaceable Routine

All rights reserved © 2020 Wisdom IT Services India Pvt. Ltd DMCA.com Protection Status

IBM-REXX Topics