Generate CD-ROM Premastering Information (QLPCDINF, QlpGenCdPremasteringInfo) API

Required Parameter Group:

1	Qualified user space name	Input	Char(20)
2	Format name	Input	Char(8)
3	Distribution set map identifier	Input	Char(10)
4	CD-ROM size	Input	Binary(4)
5	CD-ROM volume identifier prefix	Input	Char(30)
6	Error code	I/O	Char(*)

  Default Public Authority: *USE

  Service Program: QLPCDROM

  Threadsafe: No

The Generate CD-ROM Premastering Information (OPM, QLPCDINF; ILE, QlpGenCdPremasteringInfo) API allows you to do the following:

Generate the distribution set map file
A byte-stream file in the root directory is created and contains information about which tape files reside on each CD-ROM volume (only for files needed by the IBM^® i installation process, such as those saved with SAVSYS or SAVLICPGM). The name of this file is \qlptbdnnnnnnn, where tbdnnnnnnn is the name of the distribution set map identifier that is provided as an input parameter to this API. This file needs to be saved with the name QDSETMAP, using the CPYTOTAP command, to the same set of tapes prior to being sent off for mastering to CD-ROM. This file is written to each CD-ROM volume and is used by programs to ease in intelligent prompting during system installation.
Retrieve information about the files that were saved when the job was enabled for CD-ROM premastering using the Handle CD-ROM Premastering State (QLPCDRST, QlpHandleCdState) API. (Note: Premastering is the set of activities done in preparation for creating a master image as a template for manufacturing a number of copies of a CD-ROM.)
This information includes the tape file name, its corresponding CD-ROM file name (only for files needed by the IBM i installation process, such as those saved with SAVSYS or SAVLICPGM), the CD-ROM volume it will be placed on, and the volume serial position in this set of CD-ROMs. (Note: These files need to reside on the same volume: /QCDIMLP, /QCDIML, /QLANGID/SVvRrMm, /QLANGID/S_Lxxxx, /QLANGID/S_LVLlv, /QFILESCR, /QIAM400, /QFILELDS, /QFILEMCD and /QFILEBT, and these files need to reside on the same volume: /QLANGID/QVvRrMm, /QLANGID/Q_Lxxxx, /QLANGID/Q_LVLlv, /QFILEIPL and /QFILEIN)

Authorities and Locks

API Public Authority: *EXCLUDE
QSYS Library Authority: *CHANGE
User Space Authority: *CHANGE
User Space Library Authority: *USE
User Space Lock: *EXCLRD

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

The user space that receives the generated list and the library in which it is located. The first 10 characters contain the user space name, and the second 10 characters contain the library name.

The following special values are allowed for the library name:

*CURLIB	The current library is used to locate the user space. If there is no current library, QGPL (general purpose library) is used.
*LIBL	The library list is used to locate the user space.

Format name

INPUT; CHAR(8)

The content and format of the information returned.

The possible format name follows:

PCDL0100	Premastering information
	For more information, see PCDL0100 List Data Section.

Distribution set map identifier

INPUT; CHAR(10)

The distribution set map identifier that uniquely establishes this set of CD-ROMs being premastered.

This name can only include the following characters:

Uppercase characters (A-Z)
Numeric characters (0-9)
Underscore character (_)

This identifier should be the same as that specified on the Handle CD-ROM Premastering State API.

CD-ROM size

INPUT; BINARY(4)

The size of the CD-ROM in megabytes that is used during mastering. This information is needed to accurately calculate where the tape files reside on CD-ROM.

CD-ROM volume identifier prefix

INPUT; CHAR(30)

The prefix of the volume identifier for the CD-ROM volumes. Each CD-ROM will be assigned a unique volume identifier starting with these 30 characters. A 2-digit numeric suffix is added to this prefix and then incremented for each CD-ROM volume in the set. For example, the volume identifiers for a 3-volume CD-ROM set when a prefix of MYCDS is used would be MYCDS01, MYCDS02, and MYCDS03.

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 List

The file member list consists of:

A user area
A generic header
An input parameter section
A header section
A list data section:
- PCDL0100 format

For details about the user area and generic header, see User spaces. 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. For examples of how to process lists, see Examples: APIs and exit programs.

Input Parameter Section

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	User space name specified
10	A	CHAR(10)	User space library name specified
20	14	CHAR(8)	Format name specified
28	1C	BINARY(4)	CD-ROM size
32	20	CHAR(10)	Distribution set map identifier
42	2A	CHAR(30)	CD-ROM volume identifier prefix

Header Section

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(10)	User space name used
10	A	CHAR(10)	User space library name used

PCDL0100 List Data Section

Offset		Type	Field
Dec	Hex	Type	Field
0	0	CHAR(17)	Tape file label
17	11	CHAR(256)	CD-ROM file name
273	111	CHAR(32)	CD-ROM volume identifier
305	131	CHAR(3)	Reserved
308	134	BINARY(4)	CD-ROM volume serial position

Field Descriptions

CD-ROM file name. The name of the file as it will be on CD-ROM.

CD-ROM size. The size of the CD-ROM in megabytes that is used during mastering.

CD-ROM volume identifier. The CD-ROM volume identifier for the CD-ROM volume that this file will be on.

CD-ROM volume identifier prefix. The 30-character prefix of the volume identifier for the CD-ROM volumes that was specified in the call to the API.

CD-ROM volume serial position. The position in a set of CD-ROMs that this CD-ROM volume is in.

Distribution set map identifier. The distribution set map identifier that was specified in the call to the API.

Format name specified. The format name that was passed to this API on the call in the format name parameter.

Reserved. An ignored field.

Tape file label. The name of the file that was saved to tape.

User space library name specified. The name of the user space library as specified on the call to the API.

User space library name used. The actual name of the library where this user space was found.

User space name specified. The name of the user space as specified on the call to the API.

User space name used. The actual name of the user space used to store the data listed.

Error Messages

Message ID	Error Message Text
CPF24B4 E	Severe error while addressing parameter list.
CPF3C1E E	Required parameter &1 omitted.
CPF3C21 E	Format name &1 is not valid.
CPF3C36 E	Number of parameters, &1, entered for this API was not valid.
CPF3C90 E	Literal value cannot be changed.
CPF3CF1 E	Error code parameter not valid.
CPF3CF2 E	Error(s) occurred during running of &1 API.
CPF3DA4 E	CD-ROM size parameter &1 not valid.
CPF3DA5 E	File will not fit on a CD-ROM.
CPF3D9D E	Information about distribution set map not found.
CPF3D9E E	Distribution set map identifier &1 is not valid.
CPF9801 E	Object &2 in library &3 not found.
CPF9802 E	Not authorized to object &2 in &3.
CPF9803 E	Cannot allocate object &2 in library &3.
CPF9804 E	Object &2 in library &3 damaged.
CPF9807 E	One or more libraries in library list deleted.
CPF9808 E	Cannot allocate one or more libraries on library list.
CPF9810 E	Library &1 not found.
CPF9820 E	Not authorized to use library &1.
CPF9830 E	Cannot assign library &1.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V3R6

[ Back to top | Software Product APIs | APIs by category ]