Open List of Activation Attributes (QWVOLACT) API

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:

• Get List Entries (QGYGTLE)
• Find Entry Number in List (QGYFNDE)
• Close List (QGYCLST)

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 one of the following format names:

RACT0100	This format is described in RACT0100 Format.
RACT0200	This is the recommended format for those targeting their programs to release V7R6M0 or later. This format uses 8 bytes for fields that may return a value greater than 4,294,967,295. This format is described in RACT0200 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 '8-byte 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.

RACT0200 Format

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

Field Descriptions

Activation number. The activation number of the activation listed. This number uniquely identifies the activation within the job. This is the last 4 bytes of an 8-byte internal number and the full 8-byte value can be retrieved using the "Activation number long" field.

Activation number long. The 8-byte 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.
name	The name of the activation group.

Activation group number. The activation group number of the activation group listed. This number uniquely identifies the activation group within the job. This is the last 4 bytes of an 8-byte internal number and the full 8-byte value can be retrieved using the "Activation group number long" field.

Activation group number long. The 8-byte 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.
name	The name of the library containing the program.

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

*N	The program no longer exists in the system.
name	The name of the program.

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

Reserved. An ignored field.

Static storage size. The total amount of static storage allocated to the activation in bytes. If the size exceeds the maximum value for this field (4,294,967,295 bytes), the maximum value will be returned.

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

Error Messages

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