List Product in a Save File (QLPLPRDS) API


  Required Parameter Group:

1 Qualified user space name Input Char(20)
2 Format name Input Char(8)
3 Qualified save file name Input Char(20)
4 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The List Product in a Save File (QLPLPRDS) API generates a list for all product loads found in a save file. This list contains:

The products must have been saved into the save file with the SAVLICPGM command. The list is placed in the specified user space. The generated list replaces any information in the user space.


Authorities and Locks

User Space Authority
*CHANGE
Library Authority
*EXECUTE
Save File Authority
Operational
User Space Lock
*EXCL
Save File Lock
*SHRRD

Required Parameter Group

Qualified user space name
INPUT; CHAR(20)

The user space that is to receive the created list. The first 10 characters contain the user space name. The second 10 characters contain the name of the library where the user space is located.

You can use these special values for the library name:

*CURLIB The job's current library
*LIBL The library list

Format name
INPUT; CHAR(8)

The content and format of the information returned for each product code or language load.

The possible format names are:

PRDL0100 Product ID, Release level, Product option, Load type, Language ID.

Qualified save file name
INPUT; CHAR(20)

The name of the save file where the product was saved using SAVLICPGM. The first 10 characters contain the save file name, and the second 10 characters contain the name of the library where the file is located.

You can use these special values for the library name:

*CURLIB The job's current library
*LIBL The library list

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.


Format of the Generated Lists

The list consists of:

For details about the user area and generic header, see User Space Format for List APIs. For details about the remaining items, see the following sections. For detailed descriptions of the fields in the list returned, see Field Descriptions.

When you retrieve list entry information from a user space, you must use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid.


Input Parameter Section

Offset Type Field
Dec Hex
0 0 CHAR(10) User space name specified
10 A CHAR(10) User space library name specified
20 14 CHAR(8) Format name
28 1C CHAR(10) Save file name specified
38 26 CHAR(10) Save file library name specified


Header Section

Offset Type Field
Dec Hex
0 0 CHAR(10) User space name used
10 A CHAR(10) User space library name used
20 14 CHAR(10) Save file name used
30 1E CHAR(10) Save file library name used


PRDL0100 Format

Offset Type Field
Dec Hex
0 0 CHAR(7) Product ID
7 7 CHAR(6) Release level
13 D CHAR(4) Product option
17 11 CHAR(10) Load type
27 1B CHAR(4) Language ID


Field Descriptions

Format name. The content and format of the information returned for each product.

The possible values are:

PRDL0100 Product ID, release level, product option, load type, language ID.

Language ID. The ID of the language found for the product in the save file. This field will be blank when the load type is *CODE.

Load type. The type of load found for the product in the save file.

The possible values are:

*CODE indicating the load is a code load
*LNG indicating the load is a language load

Product ID. The name of a product found in the save file whose product information is to be placed in the list.

Product option. A product option number found in the save file whose product information is to be placed in the list.

Release level. The version, release, and modification level of the product.

The format of this field is VvRrMm where:

v Product version
r Product release
m Product modification

Save file library name specified. The name of the library containing the save file whose product information is to be placed in the list.

Save file library name used. The name of the library containing the save file whose product information is placed in the list.

Save file name specified. The name of the save file specified in the call to the API.

Save file name used. The name of the save file whose product information is placed in the list.

User space library name specified. The name of the library specified in the call to the API that contains the user space.

User space library name used. The name of the library that contains the user space that is to receive the generated list.

User space name specified. The name of the space specified in the call to the API.

User space name used. The name of the user space that is to receive the generated list.


Error Messages

Message ID Error Message Text
CPF0600 E All CPF06xx messages could be returned. xx is from 01 to FF.
CPF24B4 E Severe error while addressing parameter list.
CPF3CAA E List is too large for user space &1.
CPF3CF1 E Error code parameter not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF3C1E E Required parameter &1 omitted.
CPF3C20 E Error found by program &1.
CPF3C21 E Format name &1 is not valid.
CPF3C90 E Literal value cannot be changed.
CPF3D94 E No product found in save file.
CPF3200 E All CPF32xx messages could be returned. xx is from 01 to FF.
CPF8100 E All CPF81xx messages could be returned. xx is from 01 to FF.
CPF9800 E All CPF98xx messages could be signaled. xx is from 01 to FF.


API introduced: V3R1
Top | Software Product APIs | APIs by category