QLIBDEF—query LIBDEF definition information

The QLIBDEF service allows an ISPF dialog to obtain the current LIBDEF definition information. This information can be saved by the dialog and used later to restore any LIBDEF definitions that may have been overlaid. For each LIBDEF lib-type, the ID parameter and the "type" of ID is returned. The absence of an active LIBDEF definition for a specific lib-type is indicated by the return code.

Command invocation format


>>-ISPEXEC--QLIBDEF--lib-type--+----------------+--------------->
                               '-TYPE(type-var)-'   

>--+------------+----------------------------------------------><
   '-ID(id-var)-'

Call invocation format


>>-CALL--ISPEXEC--(buf-len,--buffer);--------------------------><


>>-CALL--ISPLINK--('QLIBDEFb'----------------------------------->

>--,lib-type,,-+-type-var-+-,-+-id-var)-+----------------------><
               '-'b'------'   '-'b'-----'

Parameters

lib-type: Specifies the LIBDEF lib-type definition that is being queried. The value may be ISPPLIB, ISPMLIB, ISPSLIB, ISPTLIB, ISPLLIB, ISPILIB, ISPTABL, ISPFILE, or a generic name. The values that may be specified on a LIBDEF service may be specified on a QLIBDEF service.
type-var: Optional parameter that specifies the name of a dialog variable which is to contain the "type" of LIBDEF definition. The possible values returned are DATASET, EXCLDATA, LIBRARY or EXCLLIBR. The variable is not modified if there is no LIBDEF. It is the responsibility of the dialog developer to initialize this variable.
Note: Type-var should be initialized to blanks before every QLIBDEF call.
id-var: Optional parameter that specifies the name of a dialog variable which is to contain "ID" information. It is set to the ddname or data set name or names that were specified on the last active LIBDEF service. All data set names returned are fully qualified, even if the original LIBDEF request did not specify fully qualified names. Multiple data set names are separated by a comma. The LIBDEF service has a maximum of 15 data set names allowed in the data set list. A data set name list is bounded by parenthesis when the QLIBDEF service is requested through ISPLINK. The variable is not modified if there is no LIBDEF in effect. It is the responsibility of the dialog developer to initialize this variable.
Note: Id-var should be initialized to blanks before every QLIBDEF call.
buf-len: Specifies a fullword fixed binary integer containing the length of "buffer".
buffer: Specifies a buffer containing the name of the service and its parameters in the same form as they would appear in an ISPEXEC call for a command procedure.

Although not mandatory, it is suggested that the service interface (ISPLINK or ISPEXEC) used by the QLIBDEF be the same as that used on the LIBDEF service to restore the definition. This eliminates the need to adjust the syntax of the information returned by QLIBDEF.

Return codes

These return codes are possible:

0: A LIBDEF definition for the specified lib-type exists and the requested information, if any, has been successfully returned.
4: The specified lib-type does not have an active LIBDEF definition.
12: An invalid lib-type value of ISPPROF has been specified.
16: A dialog variable translation or truncation error has occurred.
20: A severe error has occurred.

Example

A panel library, ISPPLIB has been defined by the LIBDEF service. Query the type of LIBDEF definition and the LIBDEF "ID" information and return the type of LIBDEF definition in the variable, TYPEV, and the LIBDEF "ID" information in the variable, IDV.

ISPEXEC QLIBDEF ISPPLIB TYPE(TYPV) ID(IDV)

Set the program variable BUFFER to contain:

QLIBDEF ISPPLIB TYPE(TYPV) ID(IDV)

Set program variable BUFLEN to the length of the variable BUFFER. Issue the command:

CALL ISPEXEC (BUFLEN, BUFFER);

or alternately

CALL ISPLINK ('QLIBDEF ','ISPPLIB ','TYPEV ','IDV ');