30.06.2013 Views

Data Queue APIs--Categories - FTP Directory Listing - IBM

Data Queue APIs--Categories - FTP Directory Listing - IBM

Data Queue APIs--Categories - FTP Directory Listing - IBM

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Open List of Objects (QGYOLOBJ) API<br />

Field Descriptions<br />

Displacement to statuses. The byte offset from the beginning of the selection control format to the list<br />

of statuses requested. The offset value must be at least 20, which is past the reserved portion of the format.<br />

Length of selection control format. The total length of the selection control format. The minimum size is<br />

21 bytes, which allows for one status value. An error is returned if the length specified is less than the<br />

minimum.<br />

Number of statuses. The number of statuses specified in the statuses array. You can specify 1 through 5<br />

statuses.<br />

Reserved. An ignored field.<br />

Select or omit status value. An indicator that determines whether objects are selected or omitted from the<br />

list based on the statuses specified.<br />

This field is useful in generating a list of objects with a certain information status, such as damaged or<br />

partially damaged objects. It can also be used to generate a list of all objects except objects with a certain<br />

information status, such as unauthorized objects.<br />

Valid values are:<br />

0<br />

Select on status value<br />

1<br />

Omit on status value<br />

Statuses. The status of objects to select or omit from the list of objects generated. Valid values are all of<br />

the possible values listed under the information status field on page reference #1. The special value * can<br />

be used to select all objects with any information status field.<br />

Format of Receiver Variable<br />

To get all of the information from a format, specify the key that will return all of the fields associated with<br />

the format. There is no format parameter for this API.<br />

The offsets given in the tables below only apply if the key for a format is specified. If individual field keys<br />

are specified, the fields are returned in the order in which the keys are specified.<br />

For detailed descriptions of the fields in the table, see Field Descriptions.<br />

Dec<br />

Offset<br />

Hex Type Field<br />

0 0 CHAR(10) Object name used<br />

10 A CHAR(10) Object library name used<br />

20 14 CHAR(10) Object type used (Ref #1.)<br />

http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qgyolobj.htm (11 of 24) [10/4/1999 2:36:21 PM]

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!