RTVLIBD (Retrieve Library Description)

RTVLIBD Command syntax diagram

 

Purpose

The Retrieve Library Description (RTVLIBD) command is used in a CL program or REXX procedure to retrieve the description of a library.

The CL prompt for this command lists the minimum length for each variable next to the parameters being retrieved. For character variables, a single number is shown. For decimal variables, two numbers are shown. The first number indicates the minimum variable length and the second number indicates the minimum number of decimal positions.

 

Restrictions

1. The user cannot retrieve the attributes of a library for which they have *EXCLUDE authority.

 

Required Parameters

LIB

Specifies the name of the library for which information is being retrieved. If a variable is specified, it must be 10 characters in length and include a library name.

 

Optional Parameters

TYPE

Specifies the name of a 10-character CL variable that is used to retrieve the type of the library.

The value that can be returned is PROD or TEST.

CRTAUT

Specifies the name of a 10-character CL variable that is used to return the create authority value of the library.

The value that can be returned is *SYSVAL, *CHANGE, *ALL, *USE, *EXCLUDE, or the name of an authorization list.

ASP

Specifies the name of a decimal variable that is used to retrieve the number of the auxiliary storage pool (ASP) from which the system allocates storage for the library. In CL programs, this must be a decimal variable length of (2 0). This variable will contain an ASP number up to 32. If an ASP number is larger than 32, -1 is returned in this variable. Parameter ASPDEV should be used to return the ASP device name when the ASP number is larger than 32. The following values can be returned:

1

The library is in the system auxiliary storage pool.

2-32

The library is in a basic user auxiliary storage pool.

-1

The library is in a primary or secondary auxiliary storage pool (ASP) with an ASP number larger than 32. The ASP device name for the primary or secondary ASP can be retrieved with the ASPDEV parameter.

ASPDEV

Specifies the name of a 10-character CL variable used to return the name of the auxiliary storage pool (ASP) device where storage is allocated for the library. One of the following special values can be returned:

*N

The name of the ASP device can not be determined.

*SYSBAS

The library is in the system ASP (ASP 1) or in a basic user ASP (ASPs 2-32).>

CRTOBJAUD

Specifies the name of a 10-character variable used to return the auditing value of the library. The values that can be retrieved include *SYSVAL, *NONE, *USRPRF, *CHANGE, and *ALL. See the CRTOBJAUD parameter on the Create Library (CRTLIB) command for more information.

TEXT

Specifies the name of a 50-character CL variable that is used to return the text description to a library.

Example for RTVLIBD

CRTLIB LIB(TESTLIB) CRTAUT(*ALL)
  TEXT('John Smith library')

This command creates John Smith's library.

DCL &CRTAUT *CHAR 10
RTVLIBD LIB(TESTLIB)
  CRTAUT(&CRTAUT)

When user Smith calls a CL program containing the above, the following values are returned:

&CRTAUT `*ALL      `

Error messages for RTVLIBD

*ESCAPE Messages

CPFB8ED

Device description &1 not correct for operation.

CPF210E

Library &1 not available.

CPF2115

Object &1 in &2 type *&3 damaged.

CPF2150

Object information function failed.

CPF2151

Operation failed for &2 in &1 type *&3.

CPF980B

Object &1 in library &2 not available.

CPF9810

Library &1 not found.

CPF9820

Not authorized to use library &1.

CPF9830

Cannot assign library &1.