Retrieve Thread Attribute (QWTRTVTA) API


  Required Parameter Group:

1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 Format of receiver information Input Char(8)
4 Job or thread identification information Input Char(*)
5 Format of job identification information Input Char(8)
6 Number of fields to return Input Binary(4)
7 Key of fields to return Input Array(*) of Binary(4)
8 Reset performance statistics Input Char(1)
9 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: Conditional; see Usage Notes.

The Retrieve Thread Attribute (QWTRTVTA) API retrieves job and thread attributes that apply to the job or thread specified in the job or thread identification information parameter.


Authorities and Locks

The following authority restrictions apply only when the API is called for format name RTVT0200. All other format names have no authority restrictions.

Job Authority
When calling this API for format name RTVT0200, one of the following conditions must be met:


Required Parameter Group

Receiver variable
OUTPUT; CHAR(*)

The variable that is used to return the attribute information for the specified thread.

Length of receiver variable
INPUT; BINARY(4)

The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.

Format of receiver information
INPUT; CHAR(8)

The format of the information returned in the receiver variable. The possible format name is:

RTVT0100 See Format RTVT0100 for details on the job or thread attribute information returned.
RTVT0200 Library list information. See Format RTVT0200 for details on the library information returned for the thread.
RTVT0300 Elapsed performance statistics. See Format RTVT0300 for details on the performance statistics returned for the specified thread.

Job or thread identification information
INPUT; CHAR(*)

The information that is used to identify the job or thread within a job for which attribute information is to be returned. See Format of Job or Thread Identification Information for details.

Format of job or thread identification information
INPUT; CHAR(8)

The format of the job or thread identification information. The possible format names are:

JIDF0100 See Format of Job or Thread Identification Information for details on the job identification information.
JIDF0200 See Format of Job or Thread Identification Information for details on the job identification information.

Note: If the thread handle is available, Format JIDF0200 provides a faster method of accessing a thread that is not the current thread than Format JIDF0100.


Number of fields to return
INPUT; BINARY(4)

The number of fields to return in the specified format.

Key of fields to be returned
INPUT; ARRAY(*) of BINARY(4)

The list of fields to be returned in the specified format. For a list of valid fields, see Valid Keys.

Reset status statistics
INPUT; CHAR(1)

The elapsed time and all the key fields that are based on the elapsed time are reset to zero. If a format other than RTVT0300 is specified, this field needs to be zero. The following special values may be specified:

0 The elapsed time and the key fields based on the elapsed time are not reset.
1 The elapsed time and the key fields based on the elapsed time are reset back to zero.

Error code
I/O; CHAR(*)

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


Format RTVT0100

The RTVT0100 format returns job or thread attribute information for the specified thread. For the list of keys that are valid for job attributes and thread attributes, see Keys for RTVT0100.

Offset Type Field
Dec Hex
0 0 BINARY(4) Bytes returned
4 4 BINARY(4) Bytes available
8 8 CHAR(10) Job name
18 12 CHAR(10) User name
28 1C CHAR(6) Job number
34 22 CHAR(2) Reserved
36 24 BINARY(4), UNSIGNED Returned thread handle
40 28 CHAR(8) Returned thread identifier
48 30 CHAR(10) Job status
58 3A CHAR(2) Reserved
60 3C BINARY(4) Offset to key fields
64 40 BINARY(4) Number of fields returned
68 44 CHAR(*) Reserved
These fields repeat, in the order listed, for the number of key field returned. BINARY(4) Length of field information returned
BINARY(4) Key field
CHAR(1) Type of data
CHAR(3) Reserved
BINARY(4) Length of data
CHAR(*) Data
CHAR(*) Reserved


Field Descriptions

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Data. The data returned for the key field.

Job name. The name of the job as identified to the system. For an interactive job, the system assigns the job the name of the work station where the job started; for a batch job, you specify the name in the command when you submit the job.

Job number. The system-assigned job number.

Job status. The status of the job. The valid values are:

*ACTIVE The job has started, and it can use system resources (processing unit, main storage, and so on). This does not guarantee that the job is currently running, however. For example, an active job may be in one of the following states where it is not in a position to use system resources:
  • The Hold Job (HLDJOB) command holds the job; the Release the (RLSJOB) command allows the job to run again.
  • The Transfer Group Job (TFRGRPJOB) or Transfer Secondary Job (TFRSECJOB) command suspends the job. When control returns to the job, the job can run again.
  • The job is disconnected using the Disconnect Job (DSCJOB) command. When the interactive user signs back on, thereby connecting back into the job, the job can run again.
  • The job is waiting for any reason. For example, when the job receives the reply for an inquiry message, the job can start running again.
*JOBQ The job is currently on a job queue. The job possibly was previously active and was placed back on the job queue because of the Transfer Job (TFRJOB) or Transfer Batch Job (TFRBCHJOB) command, or the job was never active because it was just submitted.
*OUTQ The job has completed running and has spooled output that has not yet printed or the job's job log has not yet been written.

Key field. The field returned. See Valid Keys for the list of valid keys.

Length of data. The length of the data returned for the field.

Length of field information returned. The total length of information returned for this field. This value is used to increment to the next field in the list.

Number of fields returned. The number of fields returned to the application.

Offset to key fields. The offset in characters (bytes) from the beginning of the receiver to the key fields array entry.

Reserved. An ignored field.

Returned thread handle. A value which addresses a particular thread within the job. While the thread identifier uniquely identifies the thread within the job, the thread handle can improve performance when referencing the thread. This field will be 0 when called to return attributes for a job.

Returned thread identifier. A value which uniquely identifies the thread within the job. This field will be 0 when called to return attributes for a job.

Type of data. The type of data returned.

C The data is returned in character format.
B The data is returned in binary format.

User name. The user profile under which the job is started. The user name is the same as the user profile name and can come from several different sources depending on the type of job.


RTVT0200 Format

The RTVT0200 format returns library list information for the specified thread. The special value of -1 for the thread indicator field (part of the JIDF0100 format) may not be used. For the list of keys that are valid for this format, see Keys for RTVT0200.

Offset Type Field
Dec Hex
0 0 BINARY(4) Bytes returned
4 4 BINARY(4) Bytes available
8 8 CHAR(10) Job name
18 12 CHAR(10) User name
28 1C CHAR(6) Job number
34 22 CHAR(2) Reserved
36 24 BINARY(4), UNSIGNED Returned thread handle
40 28 CHAR(8) Returned thread identifier
48 30 BINARY(4) Offset to libraries in system library list
52 34 BINARY(4) Number of system libraries
56 38 BINARY(4) Offset to libraries in product library list
60 3C BINARY(4) Number of product libraries
64 40 BINARY(4) Offset to current library
68 44 BINARY(4) Number of current libraries
72 48 BINARY(4) Offset to libraries in user library list
76 4C BINARY(4) Number of user libraries
80 50 BINARY(4) Length of one library array entry
84 54 BINARY(4) Offset to ASP group information
88 58 BINARY(4) Number of ASP group information entries
92 5C BINARY(4) Length of one ASP group information entry
See note Array(*) of CHAR(*) System library list (See Library Array Entry for format of library array entry.)
Array(*) of CHAR(*) Product libraries (See Library Array Entry for format of library array entry.)
Array(*) of CHAR(*) Current library (See Library Array Entry for format of library array entry.)
Array(*) of CHAR(*) User library list (See Library Array Entry for format of library array entry.)
Array(*) of CHAR(*) ASP group information entry (See ASP Group Information Entry for format of ASP group information entry.)
Note: The decimal and hexadecimal offsets depend on the number of libraries you have in the various parts of your library lists and on keys requested. The data is left-justified and padded with blanks on the right. The array is sequential. See the CL Programming topic for the total number of libraries that can be returned to you.


Library Array Entry

The library array entry describes the data that is returned for each library entry in the array of libraries. The name of the library as well as some extended information about the library is returned with this format.

For details about the fields listed, see Field Descriptions.

Offset Type Field
Dec Hex
The fields repeat for each library object returned in the array. CHAR(10) Library name
CHAR(50) Library text description
BINARY(4) Library ASP number
CHAR(10) Library ASP name.
CHAR(*) Reserved


ASP Group Information Entry

The ASP group information entry describes the data that is returned for each ASP group. The name of the ASP group is returned with this format. For details about the fields listed, see Field Descriptions.

Offset Type Field
Dec Hex
These fields repeat for each ASP group returned. CHAR(10) ASP group name
CHAR(*) Reserved


Field Descriptions

ASP group information. The list of Auxiliary Storage Pool (ASP) group information for the current thread. This information does not include the system ASP or the basic user ASPs.

ASP group name. The name of an ASP group being used by the thread. This is the name of the primary ASP device in an ASP group.

Bytes available. All of the available bytes for use in your application.The actual length depends on how many libraries are in the library list.

Bytes returned. The number of bytes returned to the user. This may be some but not all of the bytes available.

Current library. The name of the current library for the specified thread. If no current library exists, the number of current libraries field is zero and this field has no entry in the list.

Job name. The name of the job as identified to the system. For an interactive job, the system assigns the job the name of the work station where the job started; for a batch job, you specify the name in the command when you submit the job.

Job number. The system-assigned job number.

Length of one ASP group information entry. The length of an entry in the ASP group information. Zero indicates that ASP group information is not being returned.

Length of one library array entry. The length of an entry in one of the library list entries.

Library ASP name. The name of the ASP in which the library is located. The following special values may also be returned:

*SYSBAS The library is located in the system ASP or a basic ASP.
*N The name of the ASP cannot be determined.

Library ASP number. The numeric identifier of the ASP device containing the object's library. The following values may be returned:

1 The library is located in the system ASP.
2-32 The library is located in a basic ASP.
33-255 The library is located in an independent ASP.
-1 The ASP device cannot be determined.

Library name. The name of the library object.

Library text description. The text description of the library object. This field is blank if no text description is specified.

Number of ASP group information entries. The number of elements in entries in the ASP group information. Zero indicates that ASP group information is not being returned.

Number of current libraries. The number of libraries in the current part of the library list of the specified thread.

Number of product libraries. The number of product libraries found in the library list of the specified thread.

Number of system libraries. The number of libraries in the system part of the thread's library list. This value will be zero if system libraries were not requested.

Number of user libraries. The number of libraries in the thread's user library list. This value will be zero if user libraries were not requested.

Offset to ASP group information. The offset in characters (bytes) from the beginning of the receiver to the first ASP group information entry. Zero indicates that ASP group information is not being returned.

Offset to current library. The offset in characters (bytes) from the beginning of the receiver to the current library array entry.

Offset to libraries in product library list. The offset in characters (bytes) from the beginning of the receiver to the first product library array entry.

Offset to libraries in system library list. The offset in characters (bytes) from the beginning of the receiver to the first system library array entry.

Offset to libraries in user library list. The offset in characters (bytes) from the beginning of the receiver to the first user library array entry.

Product libraries. The libraries that contain product information for the specified thread. If no product libraries exist, the number of product libraries field is zero and this field has no entry in the list.

Reserved. An ignored field.

Returned thread handle. A value which addresses a particular thread within the job. While the thread identifier uniquely identifies the thread within the job, the thread handle can improve performance when referencing the thread.

Returned thread identifier. A value which uniquely identifies the thread within the job.

System library list. The system portion of the library list of the specified thread.

User library list. The user portion of the library list for the specified thread.

User name. The user profile under which the job is started. The user name is the same as the user profile name and can come from several different sources depending on the type of job.


Format RTVT0300

The RTVT0300 format returns performance statistics information, calculated over an elapsed time, for the specified thread. The special value of -1 for the thread indicator field (part of the JIDF0100 format) may not be used. For the list of keys that are valid for this format, see Keys for RTVT0300.

Offset Type Field
Dec Hex
0 0 BINARY(4) Bytes returned
4 4 BINARY(4) Bytes available
8 8 CHAR(10) Job name
18 12 CHAR(10) User name
28 1C CHAR(6) Job number
34 22 CHAR(2) Reserved
36 24 BINARY(4), UNSIGNED Returned thread handle
40 28 CHAR(8) Returned thread identifier
48 30 BINARY(8), UNSIGNED Elapsed time
56 38 BINARY(4) Offset to key fields
60 3C BINARY(4) Number of fields returned
64 40 CHAR(*) Reserved
These fields repeat, in the order listed, for the number of key field returned. BINARY(4) Length of field information returned
BINARY(4) Key field
CHAR(1) Type of data
CHAR(3) Reserved
BINARY(4) Length of data
CHAR(*) Data
CHAR(*) Reserved


Field Descriptions

Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.

Bytes returned. The number of bytes of data returned.

Data. The data returned for the key field.

Elapsed time. The time, in milliseconds, that has elapsed between the measurement start time and the current system time. This value is 0 the first time this API is called by this job. The measurement start is set the first time this API is called and when the reset status statistics is set to reset the elapsed time.

Job name. The name of the job as identified to the system. For an interactive job, the system assigns the job the name of the work station where the job started; for a batch job, you specify the name in the command when you submit the job.

Job number. The system-assigned job number.

Key field. The field returned. See Valid Keys for the list of valid keys.

Length of data. The length of the data returned for the field.

Length of field information returned. The total length of information returned for this field. This value is used to increment to the next field in the list.

Number of fields returned. The number of fields returned to the application.

Reserved. An ignored field.

Returned thread handle. A value which addresses a particular thread within the job. While the thread identifier uniquely identifies the thread within the job, the thread handle can improve performance when referencing the thread.

Returned thread identifier. A value which uniquely identifies the thread within the job.

Type of data. The type of data returned.

C The data is returned in character format.
B The data is returned in binary format.

User name. The user profile under which the job is started. The user name is the same as the user profile name and can come from several different sources depending on the type of job.


Format of Job or Thread Identification Information

Format JIDF0100 is the format of the information needed to identify the job or the thread for which the job or thread's attributes will be returned. This format is to be used for returning job or thread information. This format supports several special values that can help in identifying the thread.

Format JIDF0200 is the format of the information needed to identify the thread for which the thread's attributes will be returned. This format is to be used when referencing a specific thread that you already have the identification information for.

Note: If the thread handle is available, Format JIDF0200 provides a faster method of accessing a thread that is not the current thread than Format JIDF0100.


JIDF0100 Format

Offset Type Field
Dec Hex
0 0 CHAR(10) Job name
10 A CHAR(10) User name
20 14 CHAR(6) Job number
26 1A CHAR(16) Internal job identifier
42 2A CHAR(2) Reserved
44 2C BINARY(4) Thread indicator
48 30 CHAR(8) Thread identifier


Field Descriptions

Internal job identifier. The internal identifier for the job. The List Job (QUSLJOB) API returns this identifier. If you do not specify *INT for the job name parameter, this parameter must contain blanks. With this parameter, the system can locate the job more quickly than with a job name.

Job name. A specific job name or one of the following special values:

* The job in which this program is running. The job number and user name must contain blanks.
*INT The internal job identifier locates the job. The job number and user name must contain blanks.

Job number. A specific job number, or blanks when the job name specified is a special value.

Reserved. An unused field. This field must contain hexadecimal zeros.

Thread identifier. A value that uniquely identifies a thread within a job. If a thread identifier is specified, a thread indicator must also be specified. If the thread indicator is not 0, this field must contain hexadecimal zeros.

Thread indicator. A value that is used to specify the thread within the job for which information is to be retrieved. If a thread indicator is specified, a thread identifier must also be specified. The following values are supported:

-1 Information should be retrieved for the job. The value for the fields requested will be retrieved from the job. If the value requested only resides in a thread, the value for the initial thread will be returned. For example, the Current user field only resides in the thread and the initial thread value will be returned. The returned thread identifier and the returned thread handle will be returned as hexadecimal zeros.
0 Information should be retrieved for the thread specified in the thread identifier field. If the value requested only resides in a job, the value for the job containing the thread will be returned.
1 Information should be retrieved for the thread that this program is currently running in. If the value requested only resides in a job, the value for the job containing the thread will be returned.
2 Information should be retrieved for the initial thread of the identified job. If the value requested only resides in a job, the value for the job containing the thread will be returned.

Note: For all of the supported values, the combination of the internal job identifier, job name, job number and user name fields must also identify the job containing the thread.

User name. A specific user profile name, or blanks when the job name specified is a special value.


JIDF0200 Format

Offset Type Field
Dec Hex
0 0 CHAR(10) Job name
10 A CHAR(10) User name
20 14 CHAR(6) Job number
26 1A CHAR(16) Internal job identifier
42 2A CHAR(2) Reserved
44 2C BINARY(4), UNSIGNED Thread handle
48 30 CHAR(8) Thread identifier


Field Descriptions

Internal job identifier. The internal identifier for the job. The List Job (QUSLJOB) API returns this identifier. If you do not specify *INT for the job name parameter, this parameter must contain blanks. With this parameter, the system can locate the job more quickly than with a job name.

Job name. A specific job name or one of the following special values:

* The job in which this program is running. The job number and user name must contain blanks.
*INT The internal job identifier locates the job. The job number and user name must contain blanks.

Job number. A specific job number, or blanks when the job name specified is a special value.

Reserved. An unused field. This field must contain hexadecimal zeros.

Thread handle. A value that addresses a particular thread within a job. While the thread identifier uniquely identifies the thread within the job, the thread handle can improve performance when referencing the thread. A valid thread handle must be specified. The thread handle is returned on several other interfaces.

Thread identifier. A value which uniquely identifies a thread within a job. A valid thread identifier must be specified.

User name. A specific user profile name, or blanks when the job name specified is a special value.


Valid Keys

The following tables indicate the valid keys for the formats specified.


Keys for RTVT0100

The following table contains a list of the valid keys for format RTVT0100. See Key Field Descriptions for the descriptions of the valid key attributes. This table contains the keys that are valid for job attributes and thread attributes.

The Scope column defines the location of the attribute. The attribute is either scoped to the job or to the thread. If a job scoped attribute is requested for a thread, the value from the job containing the thread will be returned. If a thread scoped attribute is requested for a job, the value from the initial thread will be returned.

Key Type Description Scope
101 CHAR(4) Active job status Job
102 CHAR(1) Allow multiple threads Job
103 CHAR(4) Active job status for jobs ending Job
104 CHAR(*) ASP group information Thread
201 CHAR(10) Break message handling Job
302 BINARY(4) Coded character set ID Job
303 CHAR(2) Country or region ID Job
305 CHAR(10) Current user profile Thread
311 CHAR(10) Character identifier control Job
312 BINARY(8), UNSIGNED Processing unit time used - total for the job Job
313 BINARY(8), UNSIGNED Processing unit time used for database - total for the job Job
319 BINARY(8), UNSIGNED Processing unit time used - total for the thread Thread
320 BINARY(8), UNSIGNED Processing unit time used for database - total for the thread Thread
326 CHAR(45) Client IP address - IPv4 or IPv6 Thread
401 CHAR(13) Date and time job became active Job
402 CHAR(13) Date and time job entered system Job
403 CHAR(8) Date and time job is scheduled to run Job
404 CHAR(8) Date and time job was put on this job queue Job
405 CHAR(4) Date format Job
406 CHAR(1) Date separator Job
407 CHAR(1) DBCS-capable Job
408 CHAR(10) DDM conversation handling Job
409 BINARY(4) Default wait Job
410 CHAR(13) Device recovery action Job
412 BINARY(4) Default coded character set identifier Job
413 CHAR(1) Decimal format Job
415 BINARY(8), UNSIGNED Disk I/O count - total for the job Job
418 CHAR(13) Date and time job ended Job
420 BINARY(8), UNSIGNED Disk I/O count - total for the thread Thread
423 CHAR(4) Day of week Job
501 BINARY(4) End severity Job
502 CHAR(1) End status Job
504 CHAR(10) Extended object attribute of entity thread is waiting on Thread
601 CHAR(10) Function name Job
602 CHAR(1) Function type Job
702 CHAR(10) Group profile name Thread
703 CHAR(150) Group profile name - supplemental Thread
901 CHAR(10) Inquiry message reply Job
1001 CHAR(15) Job accounting code Job
1002 CHAR(7) Job date Job
1003 CHAR(20) Job description name - qualified Job
1004 CHAR(20) Job queue name - qualified Job
1005 CHAR(2) Job queue priority Job
1006 CHAR(8) Job switches Job
1007 CHAR(10) Job message queue full action Job
1008 BINARY(4) Job message queue maximum size Job
1010 CHAR(1) Job type Job
1011 CHAR(1) Job subtype Job
1012 CHAR(10) Job user identity Job
1013 CHAR(1) Job user identity setting Job
1014 BINARY(4) Job end reason Job
1015 CHAR(1) Job log pending Job
1016 BINARY(4) Job type - enhanced Job
1017 CHAR(8) Job local time Job
1018 CHAR(10) Job log output Job
1019 CHAR(10) Job description library ASP device name Job
1020 CHAR(10) Job queue library ASP device name Job
1201 CHAR(3) Language ID Job
1202 CHAR(1) Logging level Job
1203 CHAR(10) Logging of CL programs Job
1204 BINARY(4) Logging severity Job
1205 CHAR(10) Logging text Job
1206 CHAR(10) Library of entity thread is waiting on Thread
1302 BINARY(4) Maximum processing unit time Job
1304 BINARY(4) Maximum threads Job
1305 BINARY(4) Maximum temporary storage in megabytes Job
1306 CHAR(10) Memory pool name Job
1307 CHAR(1) Message reply Job
1308 CHAR(4) Message key, when active job waiting for a message Job
1309 CHAR(20) Message queue name - qualified, when active job waiting for a message Job
1310 CHAR(10) Message queue library ASP device name, when active job waiting for a message Job
1407 CHAR(30) Name of entity thread is waiting on Thread
1501 CHAR(20) Output queue name - qualified Job
1502 CHAR(2) Output queue priority Job
1503 CHAR(10) Object type of entity thread is waiting on Thread
1601 CHAR(10) Print key format Job
1602 CHAR(30) Print text Job
1603 CHAR(10) Printer device name Job
1802 BINARY(4) Run priority (job) Job
1804 BINARY(4) Run priority (thread) Thread
1805 CHAR(10) Resources affinity group Job
1901 CHAR(20) Sort sequence table - qualified Job
1902 CHAR(10) Status message handling Job
1903 CHAR(10) Status of job on the job queue Job
1904 CHAR(26) Submitter's job name - qualified Job
1906 CHAR(20) Subsystem description name - qualified Job
1908 CHAR(10) Special environment Job
1911 CHAR(30) Server type Job
1982 CHAR(10) Spooled file action Job
2001 CHAR(1) Time separator Job
2002 BINARY(4) Time slice Job
2008 BINARY(4) Thread count Job
2009 BINARY(4) Temporary storage used in megabytes Job
2010 CHAR(4) Thread status Thread
2011 CHAR(1) Thread type Thread
2012 BINARY(4) Thread hold count Thread
2013 CHAR(20) Thread resources affinity Thread
2015 BINARY(4) Type of entity thread is waiting on Thread
2020 CHAR(10) Time zone current abbreviated name Job
2021 CHAR(50) Time zone current full name Job
2022 CHAR(7) Time zone current message identifier Job
2023 BINARY(4) Time zone current offset Job
2024 CHAR(10) Time zone description name Job
2025 CHAR(20) Time zone message file name - qualified Job
2026 CHAR(1) Time zone Daylight Saving Time indicator Job
2027 BINARY(4) Time zone year offset Job
Start of change 2301 CHAR(10) Workload group JobEnd of change


Format of ASP Group Information

The ASP group information describes the data that is returned for key 104 from the RTVT0100 format.

Offset Type Field
Dec Hex
0 0 BINARY(4) Number of entries in ASP group information
4 4 BINARY(4) Length of one ASP group information entry
This field repeats for each ASP group information entry. CHAR(*) ASP group information entry (See Format of ASP Group Information Entry for more information.)


Format of ASP Group Information Entry

The ASP group information entry describes the data that is returned for each ASP group. The name of the ASP group is returned with this format.

Offset Type Field
Dec Hex
These fields repeat for each ASP group returned. CHAR(10) ASP group name
CHAR(*) Reserved


Keys for RTVT0200

The following table contains a list of the valid keys for format RTVT0200. See Key Field Descriptions for the descriptions of the valid key attributes.

All the library keys are scoped to the thread. See Library Array Entry for format of library array entry. These keys are valid only when retrieving the library list of a specific thread. The special value of -1 for the thread indicator field (part of the JIDF0100 format) may not be used. The job or thread identification format must specify a specific valid thread.

Key Type Description
104 CHAR(*) ASP group information (thread)
310 CHAR(*) Current library
1660 Array(*) of CHAR(*) Product libraries
1980 Array(*) of CHAR(*) System library list
2110 Array(*) of CHAR(*) User library list
2703 Array(*) of CHAR(*) All portions of the library list for format RTVT0200


Keys for RTVT0300

The following table contains a list of the valid keys for format RTVT0300. See Key Field Descriptions for the descriptions of the valid key attributes. All keys specified in this table are scoped to the thread. The special value of -1 for the thread indicator field (part of the JIDF0100 format) may not be used. The job or thread identification format must specify a specific valid thread.

Key Type Description
321 BINARY(4) Processing unit used - percent during the elapsed time (thread).
322 BINARY(8), UNSIGNED Processing unit used - time during the elapsed time (thread).
323 BINARY(4) Processing unit used for database - percent during the elapsed time (thread).
324 BINARY(8), UNSIGNED Processing unit used for database - time during the elapsed time (thread) .
419 BINARY(8), UNSIGNED Disk I/O count during the elapsed time (thread).
421 BINARY(8), UNSIGNED Disk I/O count during the elapsed time - asynchronous I/O (thread).
422 BINARY(8), UNSIGNED Disk I/O count during the elapsed time - synchronous I/O (thread).
1610 BINARY(8), UNSIGNED Page fault count during the elapsed time (thread).


Key Field descriptions

The descriptions of all the valid key attributes are described in Work Management API Attribute Descriptions (WMAttrDesc).


Usage Notes

The conditions under which this API is threadsafe are as follows:

Start of change When collecting performance statistics, it is important to provide an adequate time interval. The reported values reflect both the performance of the job that the API is looking at and the performance of the job that the API is running in. For example, you may see percentages greater than 100% because of the way the API interacts with the job that it is sampling. End of change


Error Messages

Message ID Error Message Text
CPF136A E Job &3/&2/&1 not active.
CPF1866 E Value &1 for number of fields to return not valid.
CPF1867 E Value &1 in list not valid.
CPF18BF E Thread &1 not found.
CPF24B4 E Severe error while addressing parameter list.
CPF3C19 E Error occurred with receiver variable specified.
CPF3C20 E Error found by program &1.
CPF3C21 E Format name &1 is not valid.
CPF3C24 E Length of the receiver variable is not valid.
CPF3C3B E Value for parameter &2 for API &1 not valid.
CPF3C3C E Value for parameter &1 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.
CPF3C54 E Job &3/&2/&1 currently not available.
CPF3C55 E Job &3/&2/&1 does not exist.
CPF3C57 E Not authorized to retrieve job information.
CPF3C58 E Job name specified is not valid.
CPF3C59 E Internal identifier is not blanks and job name is not *INT.
CPF3CF1 E Error code parameter not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.


API introduced: V5R2

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