ADDA: Add alias

ADDA: Add alias

z/OS MVS Program Management: Advanced Facilities
SA23-1392-00

ADDA allows you to specify an alias to be added to a list of alias names.

The syntax of the ADDA call is:

[symbol]

IEWBIND

FUNC=ADDA

[VERSION=version]
[,RETCODE=retcode]
[,RSNCODE=rsncode]
,WORKMOD=workmod
,ANAME={alias | pathname}
[,ATYPE={A | S | P}]
[,ENAME=ename]
[,AMODE=amode]

FUNC=ADDA

Specifies that you are adding an alias.

VERSION=1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Specifies the version of the parameter list to be used. The default value is VERSION=1.

Note: If VERSION is defaulted or if specified as 1, 2, or 3, ATYPE cannot be specified as a macro keyword.

RETCODE=retcode — RX-type address or register (2-12)

Specifies the location of a fullword integer that is to receive the return code returned by the binder.

RSNCODE=rsncode — RX-type address or register (2-12)

Specifies the location of a 4-byte hexadecimal string that is to receive the reason code returned by the binder.

WORKMOD=workmod — RX-type address or register (2-12)

Specifies the location of an 8-byte area that contains the workmod token returned on the CREATEW request.

ANAME={alias | pathname} — RX-type address or register (2-12)

Specifies the location of a 1024–byte varying character string that contains the alias or alternate entry point name to be added to the directory of the output program library. This is an alias name if ATYPE=A, or a path name if ATYPE=S or ATYPE=P.

ENAME=ename — RX-type address or register (2-12)

Specifies the location of a varying character string up to 32767 bytes long that contains the name of the entry point that is to receive control when the program module is accessed by the name specified in ANAME. If the name specified for ENAME is not a defined label in the ESD, the program will be entered at its primary entry point. If no value is provided for ENAME, the value defaults to the value specified in ANAME. ENAME is ignored if ATYPE is S or P.

ATYPE={A | S | P}

Specifies what type of value is pointed to by ANAME. ATYPE is not supported if VERSION is defaulted or is specified as less then 4. ATYPE can be:

A: Regular alias (default)
S: The pathname for a symbolic link
P: Sympath - ANAME is the pathname to be stored in all symbolic links.

AMODE=amode — RX-type address or register (2-12)

Specifies the location of a varying character string that contains the addressing mode for the entry point specified. This value overrides any other AMODE value already specified for this entry point without affecting other entry points. The values that can be specified for AMODE are 24, 31, 64, ANY, and MIN. AMODE is ignored if ATYPE is S or P. For a detailed description of addressing modes, see z/OS MVS Program Management: User's Guide and Reference.

Processing notes

The ADDA function has no immediate effect on the output module. Instead, the symbol is added to a list of symbols that is used to generate aliases when the module is saved. If the specified symbol appeared on an earlier ADDA call or an ALIAS control statement, a warning message is issued and the latter specification replaces the original one. This list is used when the program module is saved in a program library to update the directory of the target library.

If the name you specify matches a symbol already defined in the ESD of the program module, it is processed as an alternate entry point instead of a true alias.

Alternate entry points are not supported for program objects that reside in z/OS UNIX System Services files. If a z/OS UNIX System Services path name is specified, that name becomes a true alias of the primary entry point.

Call sequence is significant for the ADDAlias function call. If multiple ADDA calls specify the same alias or alternate entry point name, the most recent specification prevails. If a subsequent INCLUDE function call specifying ALIASES=YES includes an alias to the same name, the included specification takes precedence. To be sure that the ADDA specification is used, it should follow all INCLUDE function calls specifying ALIASES=YES. If the module contains multiple text classes, the primary and alternate entry points must be defined in the same class.

Return and reason codes

The common binder API reason codes are shown in Table 1.

Return Code	Reason Code	Explanation
00	00000000	Normal completion. Symbol added to the list of aliases.
04	83000711	Alias name has already been assigned. This request will replace the previous request for this alias name.

Parameter list

If your program does not use the IEWBIND macro, place the address of the ADDA parameter list in general purpose register 1.

Table 1. ADDA parameter list

`PARMLIST`	`DS`	`0F`
	`DC`	`A(ADDA)`	Function code + version
	`DC`	`A(RETCODE)`	Return code
	`DC`	`A(RSNCODE)`	Reason code
	`DC`	`A(WORKMOD)`	Workmod token
	`DC`	`A(ANAME)`	Alias name
	`DC`	`A(ENAME)`	Entry point name
	`DC`	`A(AMODE)`	amode
	`DC`	`A(ATYPE)`	Alias type
`ADDA`	`DC`	`H'30'`	ADDA function code value
	`DC`	`H'version'`	Parameter list version number
	`DC`	`C'A'`	Type of alias:
			'A' = regular alias:
			'S' = path name for a symbolic link:
			'P' = path name to store in the link

Note: X'80000000' must be added to either the AMODE parameter (for Version 1 through 3) or the ATYPE parameter (for Version 4 or higher).