List Subsystem Job Queues (QWDLSJBQ) API

Required Parameter Group:

Qualified user space name

Input

Char(20)

List format

Input

Char(8)

Qualified subsystem name

Input

Char(20)

Error code

I/O

Char(*)

Default Public Authority: *USE

Threadsafe: No

The List Subsystem Job Queues (QWDLSJBQ) API lists the job queues for a subsystem. It also gives the job queue allocation status, indicating whether the specified subsystem is active and has allocated this job queue or not. QWDLSJBQ replaces any data that already exists in the user space.

Authorities and Locks

User Space Authority: *CHANGE
User Space Library Authority: *EXECUTE
User Space Lock: *EXCLRD
Subsystem Description Authority: *USE
Subsystem Description Library Authority: *EXECUTE

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

The user space that receives the 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. You can use these special values for the library name:

*CURLIB

The job's current library

*LIBL

The library list

List format

INPUT; CHAR(8)

The format to use for the list of job queues. You can use the following format name:

SJQL0100

Basic job queue list. For details, see Format of the Generated List.

Qualified subsystem name

INPUT; CHAR(20)

The subsystem about which to retrieve information, and the library in which the subsystem description is located. The first 10 characters contain the subsystem name, and the second 10 characters contain the library name. 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 List

The list of job queues that the QWDLSJBQ API returns into the user space consists of:

A user area
A generic header
An input parameter section
A header section
A list data section

The user area and generic header are described in User spaces. For detailed descriptions of the fields in the tables, see Field Descriptions.

Input Parameter Section

Offset

Type

Field

Dec

Hex

CHAR(10)

User space name

CHAR(10)

User space library name specified

CHAR(8)

Format name specified

CHAR(10)

Subsystem name

CHAR(10)

Subsystem library name specified

Header Section

Offset

Type

Field

Dec

Hex

CHAR(10)

Subsystem name used

CHAR(10)

Subsystem library name used

SJQL0100 Format

Offset

Type

Field

Dec

Hex

CHAR(10)

Job queue name

CHAR(10)

Job queue library name

BINARY(4)

Sequence number

CHAR(10)

Allocation indicator

CHAR(2)

Reserved

BINARY(4)

Maximum active

BINARY(4)

Maximum by priority 1

BINARY(4)

Maximum by priority 2

BINARY(4)

Maximum by priority 3

BINARY(4)

Maximum by priority 4

BINARY(4)

Maximum by priority 5

BINARY(4)

Maximum by priority 6

BINARY(4)

Maximum by priority 7

BINARY(4)

Maximum by priority 8

BINARY(4)

Maximum by priority 9

Field Descriptions

Allocation indicator. A value indicating whether or not the job queue is allocated to the specified subsystem. Valid values are:

*NO

The subsystem has not allocated this job queue. Either this subsystem is inactive, or another subsystem has allocated the job queue.

*YES

The subsystem is active and has allocated this job queue.

Format name specified. The format name as specified in the call to the API.

Job queue library name. The name of the library in which the specified job queue resides.

Job queue name. The name of a job queue specified in a subsystem description job queue entry.

Maximum active. The maximum number of jobs that can be active at the same time through this job queue entry.

Maximum by priority 1 through 9. The maximum number of jobs that can be active at the same time for each priority level (1 through 9). A -1 in this field indicates that the value is *NOMAX.

Reserved. An ignored field.

Sequence number. The job queue entry sequence number. The subsystem uses this number to determine the order in which job queues are processed. Jobs from the queue with the lowest sequence number are processed first.

Subsystem library name specified. The name or special value specified in the call to this API for the library in which the subsystem description resides.

Subsystem library name used. The name of the library in which the subsystem description resides.

Subsystem name. The name of the subsystem about which information is being returned.

Subsystem name used. The name of the subsystem about which information is being returned.

User space library name specified. The library name or special value specified in the call to this API.

User space name. The name of the user space that receives the list.

Error Messages

Message ID

Error Message Text

CPF1605 E

Cannot allocate subsystem description &1.

CPF1606 E

Error during allocation of subsystem &1.

CPF1607 E

Previous request pending for subsystem &1.

CPF1608 E

Subsystem description &1 not found.

CPF1619 E

Subsystem description &1 in library &2 damaged.

CPF1835 E

Not authorized to subsystem description.

CPF3CF1 E

Error code parameter not valid.

CPF3CF2 E

Error(s) occurred during running of &1 API.

CPF3C21 E

Format name &1 is not valid.

CPF3C90 E

Literal value cannot be changed.

CPF811A E

User space &4 in &9 damaged.

CPF8122 E

&8 damage on library &4.

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.

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.

CPF9838 E

User profile storage limit exceeded.

CPF9872 E

Program or service program &1 in library &2 ended. Reason code &3.

API introduced: V2R1

[ Back to top | Work Management APIs | APIs by category ]