Read Build Information (QLYRDBI) API

Required Parameter Group:

1	Buffer	Output	Char(*)
2	Maximum size	Input	Binary(4)
3	Read mode	Input	Char(10)
4	Buffer length	Output	Binary(4)
5	Number of records	Output	Binary(4)
6	Error code	I/O	Char(*)

Default Public Authority: *USE

Threadsafe: No

The Read Build Information (QLYRDBI) API reads one or more records from the space.

QLYRDBI reads the space starting at the first location after the last record was read. If this is the first time QLYRDBI is called, the first record following the header record is read.

After QLYRDBI has read the final record, the next call to QLYRDBI starts reading the space from the beginning again.

QLYRDBI reads one or more records depending on the value specified on the Read mode parameter. QLYRDBI does not read more records than can fit in the buffer. The buffer is determined by the Maximum-size parameter.

Authorities and Locks

None.

Required Parameter Group

Buffer

OUTPUT; CHAR(*)

A character string to contain one or more records of build information.

Maximum size

INPUT; BINARY(4)

The maximum size of the data that is expected to be returned to this call. Maximum size should be large enough to fit at least one record. If it is too small for one record, an error occurs.

Read mode

INPUT; CHAR(10)

The mode of reading.

The possible read mode values are:

*SINGLE	Read only one record.
*MULTIPLE	Read more than one record. The maximum number of records that are read is determined by the size of Maximum size.

Buffer length

OUTPUT; BINARY(4)

The length of the data returned. If records are not read, 0 is returned.

Number of records

OUTPUT; BINARY(4)

The number of records read. Number of records is 0 if no records were read, 1 if one record was read or greater than 1 if *MULTIPLE was specified on read mode and more than one record could fit in the buffer.

Error code

I/O; CHAR(*)

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

Error Messages

The LIBxxxx error messages are located in the message file QLIBMSG in the QSYS library.

Message ID	Error Message Text
LIB9005	Value specified for Maximum size parameter is not valid.
LIB9006	Value specified for Read mode parameter is not valid.
LIB9007	Value specified for Maximum size parameter is too small.
LIB9009	Build information space does not exist, or it is damaged or deleted.
LIB9010	Build information missing or no more build information.
LIB9011	Build information in the space is not complete.
CPF3CF1 E	Error code parameter not valid.
CPF3C90 E	Literal value cannot be changed.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V2R2

[ Back to top | High-level language APIs | APIs by category ]