Open List of Activation Group Attributes (QWVOLAGP) 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 Qualified job name Input Char(26)
7 Internal job identifier Input Char(16)
8 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Open List of Activation Group Attributes (QWVOLAGP) API generates a list of all the activation groups that are associated with a given job and their attributes. The QWVOLAGP 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 QWVOLAGP 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 the QWVOLAGP API 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
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 group attributes that was 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 group 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:

RAGA0100 This format is described in RAGA0100 Format.

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 group 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 List Job (QUSLJOB) API, the QWVOLAGP 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 QWVOLAGP, you would get poorer performance than by using a job name in calling QWVOLAGP.

Error code
I/O; CHAR(*)

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


RAGA0100 Format

The following table shows the information returned in the list data section of the receiver variable for the RAGA0100 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) Number of activations
24 18 BINARY(4) Number of heaps
28 1C BINARY(4) Static storage size
32 20 BINARY(4) Heap storage size
36 24 CHAR(10) Root program name
46 2E CHAR(10) Root program library
56 38 CHAR(1) Root program type
57 39 CHAR(1) Activation group state
58 3A CHAR(1) Shared activation group indication
59 3B CHAR(1) In-use indicator
60 3C CHAR(4) Reserved
64 40 BINARY(8) Activation group number long
72 48 CHAR(8) Reserved


Field Descriptions

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.

Activation group state. The state of the activation group. Possible values follow:

0 The activation group is in user state.
1 The activation group is in system state.

Heap storage size. The total amount of heap storage that is allocated to the activation group in bytes.

In-use indicator. Whether the activation group is eligible to be reclaimed. An activation group can be reclaimed by the Reclaim Activation Group (RCLACTGRP) command. Possible values follow:

0 The activation group is not in use and is eligible to be reclaimed.
1 The activation group is in use and cannot be reclaimed.

Note: It is not recommended to reclaim eligible activation groups if you are not familiar with that activation group. Other activation groups may have references to the activation group that you are reclaiming. For example, a program of one activation group could be bound to a service program that belongs to another activation group. If you reclaim the service program's activation group and then call the program, you will get a destroyed object error when the service program is referred to.

Number of activations. The total number of program activations in this activation group.

Number of heaps. The total number of heaps that are allocated by this activation group.

Reserved. An ignored field.

Root program library. The name of the library that contains the program that caused this activation group to be created. The possible value follows:

*N The program no longer exists in the system.

Note: When the activation group is the default activation group, there is no root program. Blanks are returned in this case.

Root program name. The name of the program that caused this activation group to be created. The possible value follows:

*N The program no longer exists in the system.

Note: When the activation group is the default activation group, there is no root program. Blanks are returned in this case.

Root program type. The type of program that caused this activation group to be created. Possible values follow:

N The program no longer exists in the system.
0 The type is a program or *PGM.
1 The type is a service program or *SRVPGM.
2 The type is a Java™ program.

Note: When the activation group is the default activation group, there is no root program. A blank is returned in this case.

Shared activation group indication. Whether the activation group is shared or not. A shared activation group is an activation group that belongs to more than one job at the same time. Possible values follow:

0 The activation group is not shared with other jobs.
1 The activation group is shared with other jobs.

Static storage size. The total amount of static storage allocated to the activation group 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 ]