Description

The ETDES macro is used to destroy a previously-created entry table.

Related macros

ETDEF, ETCRE, ETCON, and ETDIS

Environment

These are the requirements for the caller:

Environmental factor	Requirement
Minimum authorization:	Supervisor state or PKM 0-7
Dispatchable unit mode:	Task or SRB
Cross memory mode:	PASN=HASN=SASN or PASN¬=HASN¬=SASN
AMODE:	24- or 31-bit
ASC mode:	Primary
Interrupt status:	Enabled for I/O and external interrupts
Locks:	No locks held
Control parameters:	Must be in primary address space

Programming requirements

None.

Restrictions

An entry table can be destroyed only by the address space that owns it.

Input register information

The ETDES macro is sensitive to the SYSSTATE macro with the OSREL=ZOSV1R6 parameter

If the caller has issued the SYSSTATE macro with the OSREL=ZOSV1R6 parameter (Version 1 Release 6 of z/OS® or later) before issuing the ETDES macro, the caller does not have to place any information into any general purpose register (GPR) unless using it in register notation for a particular parameter, or using it as a base register.
Otherwise, the caller must ensure that the following general purpose register contains the specified information:
Register

Contents

13

The address of an 18-word save area

Output register information

After the caller issues the macro, the macro might use some registers as work registers or might change the contents of some registers. When the macro returns control to the caller, the contents of these registers are not the same as they were before the macro was issued. Therefore, if the caller depends on these registers containing the same value before and after issuing the macro, the caller must save these registers before issuing the macro and restore them after the system returns control.

When control returns to the caller, the general purpose registers (GPRs) contain:

Register: Contents
0-1: Used as work registers by the macro
2-13: Unchanged
14: Used as a work register by the macro
15: Return code

Performance implications

None.

Syntax

The ETDES macro is written as follows:

Syntax	Description

`name`	`name`: Symbol. Begin `name` in column 1.

␢	One or more blanks must precede ETDES.

ETDES

␢	One or more blanks must follow ETDES.

TOKEN=`addr`	`addr`: RX-type address or register (0) - (12).

,PURGE=NO	Default: PURGE=NO
,PURGE=YES

,RELATED=`value`	`value`: Any valid macro keyword specification.

Parameters

The parameters are explained as follows:

TOKEN=addr: Specifies the address of the fullword token (returned by the ETCRE macro) associated with the entry table to be destroyed.
,PURGE=NO
,PURGE=YES: Specifies whether (YES) or not (NO) the entry table is to be disconnected from all linkage tables and then destroyed.
At the time ETDES is issued, the entry table must not be connected to any linkage tables unless PURGE=YES is coded. If any outstanding connections still exist and PURGE=YES is not coded, the entry table is not destroyed and the caller is abnormally terminated.
,RELATED=value: Specifies information used to self-document macros by “relating” functions or services to corresponding services. The format and contents of the information specified can be any valid coding values.

ABEND codes

052
053

See z/OS MVS System Codes for an explanation and programmer responses for these codes.

Return codes

When ETDES macro returns control to your program, GPR 15 contains a return code.

Table 1. Return Codes for the ETDES Macro
Hexadecimal Return Code	Meaning and Action
00	Meaning: The specified entry table was destroyed. There were no connections to linkage indexes. Action: None required.
04	Meaning: The specified entry table was destroyed. There were connections to linkage indexes, PURGE=YES was specified, and the entry table was disconnected. Action: None required. However, you may take some action based upon your application.

Examples

For examples of the use of this and other cross memory macros, refer to the chapter on cross memory communication in z/OS MVS Programming: Extended Addressability Guide.