Open List of Activation Attributes (QWVOLACT) API


  Required Parameter Group:

1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 List information Output Char(80)
4 Number of records to return Input Binary(4)
5 Format name Input Char(8)
6 Activation group number Input Binary(4)
7 Qualified job name Input Char(26)
8 Internal job identifier Input Char(16)
9 Error code I/O Char(*)

  Optional Parameter Group:

10 64 bit activation group number Input Binary(8)

  Default Public Authority: *USE

  Threadsafe: No

The Open List of Activation Attributes (QWVOLACT) API generates a list of all the activation attributes that are associated with an activation group in a given job. The QWVOLACT API places the list into a receiver variable. You can access additional records by using the Get List Entries (QGYGTLE) API. On successful completion of the QWVOLACT API, a handle is returned in the list information parameter. You may use this handle on subsequent calls to the following APIs:

The records returned by QWVOLACT include an information status field that describes the completeness and validity of the information. Be sure to check the information status field before using any other information returned.


Authorities and Locks

Job Authority
*JOBCTL if the job for which activation group attributes are being retrieved has a user profile different from that of the job that calls the QWVOLACT API.

For additional information about these authorities, see the Security reference topic collection.


Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The variable that is used to return the activation attributes that you requested.

Length of receiver variable
INPUT; BINARY(4)

The length of the receiver variable.

List information
OUTPUT; CHAR(80)

Information about the list of activation attributes that were opened. For a description of the layout of this parameter, see Open list information format.

Number of records to return
INPUT; BINARY(4)

The number of records in the list to put into the receiver variable.

Format name
INPUT; CHAR(8)

The format of the information to be returned in the receiver variable. You must use the following format name:

RACT0100 This format is described in RACT0100 Format.

Activation group number
INPUT; BINARY(4)

The number of the activation group that will be used to locate the activations whose attributes are to be returned. You can use these special values for the activation group number:

-1 The activation attributes for all activation groups are returned.
-2 Retrieve the activation group number from the optional '64 bit activation group number' parameter.

Qualified job name
INPUT; CHAR(26)

The job name, the job user profile, and the job number of the job for which you want to return activation attributes.

CHAR 1-10 The job name
CHAR 11-20 The user profile
CHAR 21-26 The job number

You can use these special values for the qualified job name:

* The job in which this program is running. The rest of the qualified job name parameter must be blank.
*INT The internal job identifier locates the job. The rest of the qualified job name parameter must be blank.

Internal job identifier
INPUT; CHAR(16)

The internal name for the job. The List Job (QUSLJOB) API creates this identifier. If you do not specify *INT for the qualified job name parameter, this parameter must contain blanks.

If your application already has this information available from the QUSLJOB API, the QWVOLACT API can locate the job more quickly with this information than with a job name. However, if you call QUSLJOB solely to obtain this parameter for use by QWVOLACT, you would get poorer performance than by using a job name in calling QWVOLACT.

Error code
I/O; CHAR(*)

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


Optional Parameter Group

64 bit activation group number
INPUT; BINARY(8)

The number of the activation group that will be used to locate the activations whose attributes are to be returned. This parameter will only be honored if -2 is specified for the required activation group parameter. Unlike the activation group parameter, this parameter has no special values.


RACT0100 Format

The following table shows the information returned in each record in the receiver variable for the RACT0100 format. For a detailed description of each field, see Field Descriptions.

Offset Type Field
Dec Hex
0 0 CHAR(10) Activation group name
10 A CHAR(6) Reserved
16 10 BINARY(4) Activation group number
20 14 BINARY(4) Reserved
24 18 BINARY(4) Activation number
28 1C BINARY(4) Static storage size
32 20 CHAR(10) Program name
42 2A CHAR(10) Program library
52 34 CHAR(1) Program type
53 35 CHAR(11) Reserved
64 40 BINARY(8) Activation group number long
72 48 BINARY(8) Activation number long


Field Descriptions

Activation number. The activation number of the activation listed. This is the last 32 bits of a 64 bit internal number that uniquely identifies the activation within the job. The full 64 bit value can be retrieved using the "Activation number long" field.

Activation number long. The 64 bit activation number of the activation listed. This is an internal number that uniquely identifies the activation within the job.

Activation group name. The name of the activation group that contains the attributes listed. Possible values follow:

*DFTACTGRP The activation group is one of the default activation groups.
*UNNAMED The activation group does not have a name.

Activation group number. The activation group number of the activation group listed. This is the last 32 bits of a 64 bit internal number that uniquely identifies the activation group within the job. The full 64 bit value can be retrieved using the "Activation group number long" field.

Activation group number long. The 64 bit activation group number of the activation group listed. This is an internal number that uniquely identifies the activation group within the job.

Program library. The name of the library that contains the program that this activation is for. Possible values follow:

*N The program no longer exists in the system.

Program name. The name of the program that this activation is for. Possible values follow:

*N The program no longer exists in the system.

Program type. The type of call that this activation is for. Possible values follow:

0 The type was a program or *PGM.
1 The type was a service program or *SRVPGM.

Reserved. An ignored field.

Static storage size. The total amount of static storage allocated to the activation in bytes.


Error Messages

Message ID Error Message Text
CPF0941 E Job &3/&2/&1 no longer in system.
CPF1071 E No authority to job &3/&2/&1.
CPF136A E Job &3/&2/&1 not active.
CPF136B E Job &3/&2/&1 in use.
CPF136C E Value &2 for activation group number not valid.
CPF24B4 E Severe error while addressing parameter list.
CPF2401 E Not authorized to library &1.
CPF3C19 E Error occurred with receiver variable specified.
CPF3C21 E Format name &1 is not valid.
CPF3C51 E Internal job identifier not valid.
CPF3C52 E Internal job identifier no longer valid.
CPF3C53 E Job &3/&2/&1 not found.
CPF3C58 E Job name specified is not valid.
CPF3C59 E Internal identifier is not blanks and job name is not *INT.
CPF3C90 E Literal value cannot be changed.
CPF3CF1 E Error code parameter not valid.
CPF9830 E Cannot assign library &1.
CPF9872 E Program or service program &1 in library &2 ended. Reason code &3.
GUI0002 E &2 is not valid for length of receiver variable.
GUI0027 E &1 is not valid for number of records to return.


API introduced: V4R2

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