9.206 START_RTV_SPLF_LIST

Note: Built-In Function Rules     Usage Options

Used in conjunction with GET_SPLF_LIST_ENTRY and END_RTV_SPLF_LIST. It must be used first to provide the selection criteria for the retrieval of spool files. The selection criteria which can be specified are User Name, Output queue name and library, Form Type, User Data and Status.

Once this START_RTV_SPLF_LIST has been used to establish the selection, the GET_SPLF_LIST_ENTRY can be used to retrieve the details of the spool files.

The END_RTV_SPLF_LIST must be used after the list of spool files have been retrieved. This will close list and release the storage allocated to that list.

Refer to 9.110 GET_SPLF_LIST_ENTRY for an example.

Arguments

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Opt

User Name

This argument should contain the User Name of the spool files you want to retrieve. A value of *ALL will select all users.

Default value is *ALL.

1

10

 

 

2

A

Opt

Output Queue Name

This argument is used in conjunction with Output Queue Library to determine from which output queue to retrieve spool files. A value of *ALL will select all output queues.

Default value is *ALL.

1

10

 

 

3

A

Opt

Output Queue Library

This argument is used in conjunction with Output Queue Name to determine from which output queue to retrieve spool files.

Default value is *LIBL.

1

10

 

 

4

A

Opt

Form Type

This argument should contain the Form Type of spool files to retrieve. A value of *ALL will select all form types.

Default value is *ALL.

1

10

 

 

5

A

Opt

User Data

This argument should contain the User Data of spool files to retrieve. A value of *ALL will select spool files regardless of their user data.

Default value is *ALL.

1

10

 

 

6

A

Opt

Status

This argument should contain the Status of the spool files to select.

Default value is *ALL.

Possible values are *ALL, *CLOSED, *DEFERRED, *SENDING, *FINISHED, *HELD, *MESSAGE, *OPEN, *PENDING, *PRINTING, *READY, *SAVED, *WRITING.

1

10

 

 

 

Return Values

No

Type

Req/ Opt

Description

Min Len

Max Len

Min Dec

Max Dec

1

A

Opt

Return code.

OK = The list was opened successfully.

ER = the argument selection details are invalid.

NR = no spool files were found which match the selection arguments.

2

2