DEALLOCATE: Deallocate File Extent

The DEALLOCATE function may be used to deallocate an address converter, Data Storage, normal index or upper index extent. It can also be used to deallocate a secondary address converter when spanned records are included in the data. Only one extent may be deallocated per ADADBS execution.

graphics/util_adadbs_deallocate.png

This document covers the following topics:


Essential Parameters

ACSIZE | AC2SIZE | DSSIZE | NISIZE | UISIZE: Extent Type and Size

These parameters specify the type and size of extent to be deallocated. One and only one extent type and size may be specified. The size must be in number of RABN blocks followed by "B" (for example, DSSIZE=20B), and cannot exceed the number of unused RABNs at the end of an extent.

The extents that can be deallocated are:

  • the address converter (ACSIZE)

  • the secondary address converter, when spanned records are used (AC2SIZE)

  • Data Storage (DSSIZE)

  • the normal index (NISIZE)

  • the upper index (UISIZE).

FILE: File for Which an Extent Is Deallocated

FILE specifies the file for which the extent is to be deallocated. Specify a decimal value.

Optional Parameters

NOUSERABEND: Termination without Abend

When a parameter error or a functional error occurs while this utility function is running, the utility ordinarily prints an error message and terminates with user abend 34 (with a dump) or user abend 35 (without a dump). If NOUSERABEND is specified, the utility will not abend after printing the error message. Instead, the message "utility TERMINATED DUE TO ERROR CONDITION" is displayed and the utility terminates with condition code 20.

Note:
When NOUSERABEND is specified, we recommend that it be specified as the first parameter of the utility function (before all other parameters). This is necessary to ensure that its parameter error processing occurs properly.

PASSWORD: File Password

The password of the file for which space is to be deallocated. This parameter is required if the file is password-protected. Specify the password between apostrophes (').

STARTRABN: Starting RABN for Extent

The first RABN of the extent in which deallocation is to take place. If this parameter is omitted, the last extent for the file will be deallocated. In the address converter, only the last extent may be deallocated.

TEST: Test Syntax

The TEST parameter tests the operation syntax without actually performing the operation. Only the syntax of the specified parameters can be tested; not the validity of values and variables. See Syntax Checking with the TEST Parameter for more information on using the TEST parameter in ADADBS functions.

Example

An address converter extent of 30 blocks is to be deallocated for file 15.

ADADBS DEALLOCATE FILE=15,ACSIZE=30B