Parameter descriptions

TYPE=TAPE

Specifies a request related to the TCDB.

FUNC=QVR

Specifies a request to return the name and type of library in which the given volume is resident.

VOLUME=volume-serial-number

Specifies the name of a character variable (six-byte length) that contains the volume serial number of the volume whose residence is to be determined. The volume serial number must be left justified in the field and padded on the right with blanks.

LIBNAME=library-name

Specifies the name of a character variable (eight-byte length), that contains the name of the library where the volume is expected to reside. The library name must be left justified in the field and padded on the right with blanks.

If the volume has no volume record in the TCDB, QVR checks for the volume in the specified library. If the volume has a record in the TCDB, QVR validates that the specified library and the library indicated on the volume record match. It also checks to see the whether the volume physically resides in the library specified by this parameter.

Note: A library name of SHELF is considered invalid. The SHELF library name is reserved for shelf-resident volumes.

TCDBCHK=YES | NO

If this optional parameter is omitted or YES is specified, the QVR function attempts to retrieve the specified volume's TCDB record. TCDBCHK=YES is the default.

If this optional parameter is specified and NO is specified, the QVR function does not retrieve the specified volume's TCDB record from the catalog and only makes the call to the library manager of the specified library. With VOLINFO=YES specified, the TVI will contain only information from the library manager inventory of the library specified.

If LIBNAME is not specified, this keyword is ignored.

VOLINFO=YES | NO

Specification of VOLINFO=YES requests that QVR return the information that is available about the volume from both the volume record in the TCDB and the library manager inventory. The returned information is mapped by the CBRTVI mapping macro.

SUBPOOL=spno

Specifies the name of a bit variable (1-byte length) that contains the number of the subpool from which storage for the volume information is obtained. If no subpool is specified, storage is obtained from subpool 0 in the key of the caller. This keyword is only used when VOLINFO=YES is specified, and is otherwise ignored.

LOC=ANY | BELOW

ANY specifies that the storage for the requested information may be obtained above the 16-megabyte line. BELOW specifies that the storage for the requested information is to be obtained below the 16-megabyte line. BELOW is the default if the LOC keyword is omitted. The LOC option is ignored if STORADDR is specified.

STORADDR=TVI-storage-address

Specifies a 4-byte address for LCS External Services to use when returning tape volume information; this information is mapped by the CBRTVI macro. The CBRTVI macro validates TVI header information for the storage specified by STORADDR, as follows:

The value for TVIID must be TVI.
The value for TVILENG must be at least as large as the TVI mapping macro length currently supported by LCS External Services.

The STORADDR keyword is ignored unless you specify VOLINFO=YES on the QVR function. Specifying STORADDR on subsequent invocations allows you to reuse the TVI storage that was obtained by LCS External Services on the initial QVR invocation. Specifying the LCSTVI@ address as the STORADDR value enables the storage to be reused, reducing the number of storage requests that are required for multiple QVR invocations.

Recommendation: On the initial invocation of the QVR function, where VOLINFO=YES is specified, allow LCS External Services to obtain the TVI storage. This ensures that the proper CBRTVI mapping macro length is obtained. (This length may change with future enhancements.) On subsequent QVR invocations, you can then specify the TVI address returned on the initial invocation (LCSTVI@) as the STORADDR value, thereby reusing the storage. The TVILENG value returned on the initial invocation is the appropriate value for freeing this storage when all QVR invocations are complete.