Open List of Objects (QGYOLOBJ) 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 | Sort information | Input | Char(*) |
| 6 | Object and library name | Input | Char(20) |
| 7 | Object type | Input | Char(10) |
| 8 | Authority control | Input | Char(*) |
| 9 | Selection control | Input | Char(*) |
| 10 | Number of keyed fields to return | Input | Binary(4) |
| 11 | Key of fields to return | Input | Array(*) of Binary(4) |
| 12 | Error Code | I/O | Char(*) |
Optional Parameter Group 1:
| 13 | Job identification information | Input | Char(*) |
| 14 | Format of job identification information | Input | Char(8) |
Optional Parameter Group 2:
| 15 | Auxiliary storage pool (ASP) control | Input | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Open List of Objects (QGYOLOBJ) API lets you generate a list of object names and descriptive information based on specified selection parameters. The QGYOLOBJ 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 this 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)
You can use the QGYOLOBJ API to:
- Open a list of objects in a library
- Open a list of objects of only one type
- Open a list of objects in another thread's library list
- Open a list of objects in the QTEMP library for another job
- Write an application program to move programs from the QRPLOBJ library back to their original location
- Provide backup analysis based on when the object was last saved or last updated
- Provide source member and object analysis from source member information to verify that the current source was used to create the specified object
The records returned by QGYOLOBJ 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.
Note: The QTEMP library and the system portion of the library list could be different between the main job and the server job when the list is being built asynchronously. If this is a problem, then request that the list be built synchronously.
For more information, see the Process Open List APIs.
Authorities and Locks
If the user is authorized to the library, some object information is always returned for the objects meeting the search criteria identified in the required parameter group. To return any of the data identified in the key fields, the user must be authorized to the objects. The information status field in the receiver variable is set to 'A' when the user is not authorized to the objects. A value of *NOTAVL will be returned for the object auditing information unless you have either all object (*ALLOBJ) or audit (*AUDIT) special authority.
- Auxiliary Storage Pool (ASP) Device Authority
- *EXECUTE when a specific auxiliary storage pool (ASP) device name is
specified for the auxiliary storage pool (ASP) control
parameter.
See note under
Object Authority.
- Object Authority
- To return any of the data identified in the key fields,
you need the object authorities
specified in the Authority control parameter. See note
below.
Note: When
*ANY authority is checked for objects, the user must have the required
authorities listed for the ASP device, object, and library or the user
must be authorized to the Database Administrator function of the IBM i through
System i™ Navigator's Application Administration support. The Change
Function Usage (CHGFCNUSG) command, with a function ID of QIBM_DB_SECADM,
can also be used to change the list of users allowed to use the
function.
- Object Library Authority
- Job Authority
- When optional parameter group 1 is specified, the API must be called from
within the thread for which the object list is being retrieved, or the caller
of the API must be running under a user profile that is the same as the job
user identity of the job for which the object list is being retrieved.
Otherwise, the caller of the API must be running under a user profile that has
job control (*JOBCTL) special authority.
The job user identity is the name of the user profile by which a job is known to other jobs. It is described in more detail in the Work management topic collection.
Library authorities specified
in the Authority control parameter. See note under Object
Authority.Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The variable used to return the number of records requested (given in the number of records to return parameter) of object information. For details about the structure of the receiver variable, see Format of Receiver Variable.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable.
- List information
- OUTPUT; CHAR(80)
Information about the list of objects that was 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 after filtering and sorting has been done. Possible values follow:
-1 All records are built synchronously in the list. 0 All records are built asynchronously in the list. If a positive number of records is specified at least that many are built synchronously (in order to return those immediately to the caller of this API) and the remainder are built asynchronously by a server job.
- Sort information
- INPUT; CHAR(*)
Information about which fields within the record structure to sort. For the layout of this structure, see Sort Information Format.
- Object and library name
- INPUT; CHAR(20)
The object and library names to place in the list. The first 10 characters contain the object name, which may be a simple name, a generic name, or the special values *ALL, *ALLUSR, or *IBM. If *ALLUSR or *IBM i s used, the library name must be *LIBL or QSYS and the object type parameter must be *LIB. When QSYS is specified, the list of libraries returned varies with the device name specified in the auxiliary storage pool (ASP) control parameter.
- When *ALLUSR is specified
with a library name of *LIBL and an object type parameter of *LIB, a list of
all user libraries in the thread's library name space is returned. When *LIBL
is specified, the auxiliary storage pool (ASP) device name must be an asterisk
(*) if the auxiliary storage pool (ASP) control parameter is specified. Refer
to *ALLUSR in the description of the second 10 characters of this parameter for
a definition of user libraries.
- When *ALLUSR is specified with a library name of QSYS and an object type
parameter of *LIB, a list of all user libraries in the auxiliary storage pools
defined by the auxiliary storage pool (ASP) control parameter is returned.
Refer to *ALLUSR in the description of the second 10 characters of this
parameter for a definition of user libraries.
- When *IBM i s specified with a library name of *LIBL and an object type of
*LIB, a list of libraries in the thread's library name space that are saved or
restored on the Save Library (SAVLIB) or Restore Library (RSTLIB) CL command
with LIB(*IBM) is returned. When *LIBL is specified, the auxiliary storage pool
(ASP) device name must be an asterisk (*) if the auxiliary storage pool (ASP)
control parameter is specified.
- When *IBM i s specified with a library name of QSYS and an object type of *LIB, a list of libraries in the auxiliary storage pools specified by the auxiliary storage pool (ASP) control parameter that are saved or restored on the Save Library (SAVLIB) or Restore Library (RSTLIB) CL command with LIB(*IBM) is returned.
Library name errors are reported with escape messages when a single library is specified. When searching a set of libraries (library specified as *ALL, *ALLUSR, *LIBL, or *USRLIBL or auxiliary storage pool (ASP) device name specified as *ALLAVL), library errors are reported with diagnostic messages and processing continues. Library authority error messages are not sent when searching a set of libraries. Escape messages are not sent for object name errors. To determine if errors occurred on the object, check the list information returned and the information status field in the receiver variable.
The second 10 characters identify the name of the library or libraries to search for the specified objects. The following special values are allowed:
*ALL All libraries in the auxiliary storage pools defined by the auxiliary storage pool (ASP) control parameter are searched. *ALLUSR All user libraries in the auxiliary storage pools (ASPs) defined by the auxiliary storage pool (ASP) control parameter are searched. User libraries are all libraries with names that do not begin with the letter Q. For information about the libraries included, see *ALLUSR in Generic library names. *CURLIB The thread's current library is searched. When this value is used, the auxiliary storage pool (ASP) device name in the auxiliary storage pool (ASP) control parameter must be an asterisk (*), if specified. *LIBL All libraries in the thread's library list are searched. When this value is used, the auxiliary storage pool (ASP) device name in the auxiliary storage pool (ASP) control parameter must be an asterisk (*), if specified. *USRLIBL All libraries in the user portion of the thread's library list are searched. When this value is used, the auxiliary storage pool (ASP) device name in the auxiliary storage pool (ASP) control parameter must be an asterisk (*), if specified. When optional parameter group 1 is specified and the job is not the current job, the library name must be QTEMP or a special value of *CURLIB, *LIBL, or *USRLIBL.
- When *ALLUSR is specified
with a library name of *LIBL and an object type parameter of *LIB, a list of
all user libraries in the thread's library name space is returned. When *LIBL
is specified, the auxiliary storage pool (ASP) device name must be an asterisk
(*) if the auxiliary storage pool (ASP) control parameter is specified. Refer
to *ALLUSR in the description of the second 10 characters of this parameter for
a definition of user libraries.
- Object type
- INPUT; CHAR(10)
The types of objects to search for. You may either enter a specific object type, or the special value *ALL. For a complete list of the available object types, see External object types.
- Authority control
- INPUT; CHAR(*)
The authority to check for on objects and libraries. This parameter can be used with the selection control parameter to select the objects to which a user is authorized. To accomplish this, specify a select or omit status value in the selection control parameter. The object name information is always returned for objects meeting the search criteria. (This assumes the job has the required authority to the library.) The information status field is set to an 'A' when the job does not have the object authority that is specified.
The following example shows what you would specify to obtain a subset of all objects that you have object management authority to.
The authority control parameter would contain:
- Length of authority control format: 48
- Call level: 1
- Displacement to object authorities: 28
- Number of object authorities: 1
- Displacement to library authorities: 38
- Number of library authorities: 1
- Object authorities: '*OBJMGT '
- Library authorities: '*USE '
The selection control parameter would contain:
- Length of selection control format: 21
- Select or omit status value: 1
- Displacement to statuses: 20
- Number of statuses: 1
- Statuses: 'A'
Because the program that calls the QGYOLOBJ API adopts authority, the authority check should be done at the call level previous to the current level (thus call level 1). With call level 1, the list would not include any objects for which you have adopted authority by the current program.
The select or omit status value of 1 indicates that the returned list will omit the objects you do not have object management authority to. This authority is specified in the object authorities field.
The format of this parameter is described in Authority Control Format.
- Selection control
- INPUT; CHAR(*)
The criteria used to select or filter objects from the list based on specified information status values.
This parameter is useful to reduce the total number of objects returned in the list. The list of objects can be generated with only the specific status that you are interested in. For example, this might be all damaged objects or all objects that the caller of the API is not authorized to. The list of objects also can be generated with all objects except objects of a specific status.
The following example shows what you would specify to select all damaged objects:
- Length of selection control format: 22
- Select or omit status value: 0
- Displacement to statuses: 20
- Number of statuses: 2
- Statuses: DP
The format of this parameter is described in Selection Control Format.
- Number of keyed fields to return
- INPUT; BINARY(4)
The number of keyed fields to return. This is the number of array elements specified for the key of fields to be returned parameter.
- Key of fields to be returned
- INPUT; ARRAY(*) of BINARY(4)
The list of the fields to be returned. For a list of the valid keys, see Valid Keys.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter . If this parameter is omitted, diagnostic and escape messages are issued to the application.
Optional Parameter Group 1
- Job identification information
- INPUT; CHAR(*)
The information that is used to identify the thread within a job for which objects can be searched using the thread's library list. The format of this parameter is described in Job Identification Information Formats.
When this parameter is specified and the job is not the current job, the library name must be QTEMP or a special value of *CURLIB, *LIBL, or *USRLIBL.
A limited amount of information is returned for objects in another job's QTEMP library. Information is returned for keys 201, 202, 203, 205, 701, and 702 only. Any other keys requested will have blanks, hexadecimal 0 (date fields), or 0 returned.
- Format of job identification information
- INPUT; CHAR(8)
The format of the job identification information. See Job Identification Information Formats for details. The possible format names are:
JIDF0000 See JIDF0000 Format for details on this format. This format is provided to simplify the coding of this parameter when this parameter must be specified because optional parameter groups after this one are to be specified and the functions provided by the other formats of this parameter are not needed. Using this format gives the same result as if optional parameter group 1 were not specified. The information retrieved is for the thread in which this program is running. JIDF0100 See JIDF0100 Format for details on this format. JIDF0200 See JIDF0200 Format for details on this format. If the thread handle is available, format JIDF0200 provides faster access than format JIDF0100 to a thread other than the current thread.
Optional Parameter Group 2
- Auxiliary storage pool (ASP) control
- Input; CHAR(*)
The information used to define the auxiliary storage pool (ASP) to search. The format of this parameter is described in Auxiliary Storage Pool (ASP) Control Format.
Sort Information Format
The following shows the format of the sort information parameter. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Number of keys to sort on |
| Offsets vary. These fields repeat for each sort key field. | BINARY(4) | Sort key field starting position | |
| BINARY(4) | Sort key field length | ||
| BINARY(2) | Sort key field data type | ||
| CHAR(1) | Sort order | ||
| CHAR(1) | Reserved. | ||
Note: If the last three fields (sort key field data type, sort order and the reserved field) are not used, they must be set to hexadecimal zeros. This causes all the data to be treated as character data, and it is sorted in ascending order.
Field Descriptions
Number of keys to sort on. The number of fields within the record structure to sort on. If zero is specified, the list is not sorted.
Reserved. An unused. This field must contain hexadecimal zeros.
Sort key field data type. The data type of the field to sort on. Refer to the key data type field in the Sort (QLGSORT) API for information about the list of data types available.
Sort key field length. The length of the field to sort on.
Sort key field starting position. The starting position of the field within the record of information to sort on.
Sort order. Whether the list should be sorted in ascending or descending order according to the key.
| 1 | Sort in ascending order. |
| 2 | Sort in descending order. |
Authority Control Format
The following shows the format of the authority control parameter. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of authority control format |
| 4 | 4 | BINARY(4) | Call level |
| 8 | 8 | BINARY(4) | Displacement to object authorities |
| 12 | C | BINARY(4) | Number of object authorities |
| 16 | 10 | BINARY(4) | Displacement to library authorities |
| 20 | 14 | BINARY(4) | Number of library authorities |
| 24 | 18 | BINARY(4) | Reserved |
| ARRAY(*) of CHAR(10) | Object authorities | ||
| ARRAY(*) of CHAR(10) | Library authorities | ||
Field Descriptions
Call level. The number of call levels to go back in the call stack to do the authority check.
For example, if the program that calls this API adopts authority, you probably would not want the authority check to use the adopted authority. Therefore, the authority check should be done at the call level previous to the current level. This field should then contain a 1. You can check the authority at various call levels by specifying a number equivalent to the call level. For example, to check the authority at the current call level, specify a 0. To check the authority at the previous call level, specify a 1.
This field must be greater than or equal to 0 and less than the number of programs in the call stack.
Displacement to library authorities. The byte offset from the beginning of the authority control format to the list of library authorities. The offset value must be 0, 28, or a number greater than 28. When 0 is specified, the number of library authorities should also be 0. A value of 28 is past the reserved portion of the format.
Displacement to object authorities. The byte offset from the beginning of the authority control format to the list of object authorities. The offset value must be 0, 28, or a number greater than 28. When 0 is specified, the number of object authorities should also be 0. A value of 28 is past the reserved portion of the format.
Length of authority control format. The total length of the authority control format. The minimum size is 28 bytes. When the size is 28, it is assumed that the number of library authorities and the number of object authorities are both 0. To allow for one object and one library authority, the size should be 48 bytes. An error is returned if the length specified is less than the minimum.
Library authorities. The authority to check for libraries.
The array can contain up to ten 10-character fields. If the number of library
authorities is 0, *EXECUTE authority is checked for on the
libraries. See note under
Object Authority in the Authorities and Locks
section.
The authority values can be specified in any combination. If *ALL, *CHANGE, or *USE is specified with any of the other authority values, the authority checked is the cumulative authority value.
The maximum number of authorities that can be specified is 10. This equals all of the specific object and data authorities that can be listed separately.
The following identifies the type of authority the user has to the library:
| *ALL | All authority |
| *CHANGE | Change authority |
| *USE | Use authority |
| *OBJOPR | Object operational authority |
| *OBJMGT | Object management authority |
| *OBJEXIST | Object existence authority |
| *OBJALTER | Alter authority |
| *OBJREF | Reference authority |
| *READ | Read authority |
| *ADD | Add authority |
| *UPD | Update authority |
| *DLT | Delete authority |
| *EXECUTE | Execute authority |
Number of library authorities. The number of authorities specified in the library authorities array. You can specify 0 through 10 authorities. When 0 is specified, *EXECUTE authority is checked for on the libraries.
Number of object authorities. The number of authorities specified in the object authorities array. You can specify 0 through 11 authorities. When 0 is specified, *ANY authority is checked for on the objects.
Object authorities. The authority to check for objects. The
array can contain up to eleven 10-character fields. If the number of object
authorities is 0, *ANY authority is checked for on the
objects. See note under
Object Authority in the Authorities and Locks
section.
The authority values can be specified in any combination with the exception of the special value *ANY. This must be specified as the only value. If *ALL, *CHANGE, *USE, or *AUTLMGT is specified with any of the other authority values, the authority checked is the cumulative authority value.
The maximum number of authorities that can be specified is 11, which equals all the specific object and data authorities and *AUTLMGT authority.
The following identifies the type of authority the user has to the object:
| *ALL | All authority |
| *CHANGE | Change authority |
| *USE | Use authority |
| *AUTLMGT | Authorization list management authority. (This value is valid only if the object type is *AUTL. It will be ignored for other object types.) |
| *OBJOPR | Object operational authority |
| *OBJMGT | Object management authority |
| *OBJEXIST | Object existence authority |
| *OBJALTER | Alter authority |
| *OBJREF | Reference authority |
| *READ | Read authority |
| *ADD | Add authority |
| *UPD | Update authority |
| *DLT | Delete authority |
| *EXECUTE | Execute authority |
| *ANY | Some authority other than *EXCLUDE. (If this value is specified, no other values can be specified.) |
Reserved. An unused field. This field must contain hexadecimal zeros.
Selection Control Format
The following shows the format of the selection control parameter. For detailed descriptions of the fields in the table, see Field Descriptions .
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of selection control format |
| 4 | 4 | BINARY(4) | Select or omit status value |
| 8 | 8 | BINARY(4) | Displacement to statuses |
| 12 | C | BINARY(4) | Number of statuses |
| 16 | 10 | BINARY(4) | Reserved |
| ARRAY(*) of CHAR(1) | Statuses | ||
Field Descriptions
Displacement to statuses. The byte offset from the beginning of the selection control format to the list of statuses requested. The offset value must be at least 20, which is past the reserved portion of the format.
Length of selection control format. The total length of the selection control format. The minimum size is 21 bytes, which allows for one status value. An error is returned if the length specified is less than the minimum.
Number of statuses. The number of statuses specified in the statuses array. You can specify 1 through 5 statuses.
Reserved. An unused field. This field must contain hexadecimal zeros.
Select or omit status value. An indicator that determines whether objects are selected or omitted from the list based on the statuses specified.
This field is useful in generating a list of objects with a certain information status, such as damaged or partially damaged objects. It can also be used to generate a list of all objects except objects with a certain information status, such as unauthorized objects.
| 0 | Select on status value |
| 1 | Omit on status value |
Statuses. The status of objects to select or omit from the list of objects generated. Valid values are all of the possible values listed under the Information status field in the Format of Receiver Variable. The special value * can be used to select all objects with any information status field.
Job Identification Information Formats
JIDF0000 Format
The following shows the details of format JIDF0000. For detailed descriptions of the field in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Default job name |
Field Descriptions
Default job name. This field must contain an asterisk '* '. The information retrieved is for the thread in which this program is running.
JIDF0100 Format
The following shows the details of format JIDF0100 of the information needed to identify the thread's library list used for an object search. For detailed descriptions of the fields in the table, see Field Descriptions.
| 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. The unique value that is used to identify the thread within the job. If the thread indicator is not 0, this field must contain hexadecimal zeros.
Thread indicator. The value that is used to specify the thread within the job for which information is to be retrieved. The following values are supported:
| 0 | Specifies that information should be retrieved for the thread specified in the thread identifier field. |
| 1 | Specifies that information should be retrieved for the thread that this program is currently running in. The combination of the internal job identifier, job name, job number, and user name fields must also identify the job containing the current thread. |
| 2 | Information should be retrieved for the initial thread of the identified job. |
User name. A specific user profile name, or blanks when the job name specified is a special value.
JIDF0200 Format
The following shows the details of format JIDF0200 for the information needed to identify the thread's library list used for an object search. For detailed descriptions of the fields in the table, see Field Descriptions.
| 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 which is used to address a particular thread within a job. A valid thread handle must be specified. The thread handle is returned on several other interfaces.
Thread identifier. A value which is used to uniquely identify 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.
Auxiliary Storage Pool (ASP) Control Format
The following shows the format of the auxiliary storage pool (ASP) control parameter. This parameter is used to define the auxiliary storage pools (ASPs) to search. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of auxiliary storage pool (ASP) control format |
| 4 | 4 | CHAR(10) | Auxiliary storage pool (ASP) device name |
| 14 | E | CHAR(10) | Auxiliary storage pool (ASP) search type |
Field Descriptions
Auxiliary storage pool (ASP) device name. The name of an auxiliary storage pool (ASP) device in which storage is allocated for the library that contains the object. The ASP device must have a status of 'Available'. This parameter must be an asterisk (*) if optional parameter group 2 is specified when *CURLIB, *LIBL, or *USRLIBL is specified as the library name in the object and library name parameter. If optional parameter group 2 is omitted in cases where it is valid for the ASP device name to have a value other than an asterisk (*), the thread's library name space will be used. One of the following special values may be specified:
| * | The ASPs in the thread's library name space. |
| *SYSBAS | The system ASP (ASP 1) and defined basic user ASPs (ASPs 2-32). |
| *CURASPGRP | The ASPs in the current thread's ASP group. |
| *ALLAVL | All available ASPs. This includes the system ASP (ASP 1), all defined basic user ASPs (ASPs 2-32), and all available primary and secondary ASPs (ASPs 33-255 with a status of 'Available'). The ASP groups are searched in ascending alphabetical order by the primary ASP name. The system ASP and all defined basic user ASPs are searched after the ASP groups. ASPs and libraries to which you are not authorized are bypassed and no authority error messages are sent. |
Auxiliary storage pool (ASP) search type. The type of the search when a specific auxiliary storage pool (ASP) device name is specified for the ASP device name field. This field must be blanks when a special value is specified for the auxiliary storage pool (ASP) device name field. One of the following values may be specified:
| *ASP | Only the single ASP named in the auxiliary storage pool (ASP) device name field will be searched. |
| *ASPGRP | All ASPs in the auxiliary storage pool (ASP) group named in the auxiliary storage pool (ASP) device name field will be searched. The device name must be the name of the primary auxiliary storage pool (ASP) in the group. |
Length of auxiliary storage pool (ASP) control format. The total length of the auxiliary storage pool (ASP) control format. The length can be 0 bytes to indicate that no auxiliary storage pool (ASP) control information is provided. Otherwise, the length must be 24 bytes. An error is returned if the length specified is not 24 or 0.
Format of Receiver Variable
To get all of the information from a format, specify the key that will return all of the fields associated with the format. There is no format parameter for this API.
The offsets given in the tables below apply only if the key for a format is specified. If individual field keys are specified, the fields are returned in the order in which the keys are specified.
For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Object name used |
| 10 | A | CHAR(10) | Object library name used |
| 20 | 14 | CHAR(10) | Object type used |
| 30 | 1E | CHAR(1) | Information status |
| 31 | 1F | CHAR(1) | Reserved |
| 32 | 20 | BINARY(4) | Number of fields returned |
| Offsets vary. these fields repeat, in the order listed, for each key field selected. | BINARY(4) | Length of field information returned | |
| BINARY(4) | Key field for field returned | ||
| CHAR(1) | Type of data | ||
| CHAR(3) | Reserved | ||
| BINARY(4) | Length of data returned | ||
| CHAR(*) | Data | ||
| CHAR(*) | Reserved | ||
Field Descriptions
Data. The actual data contained in the keyed field.
Information status. Whether the QGYOLOBJ API returns the requested information for this object. If you do not request any keys to be returned, ignore this field. Possible values are:
| blank | The requested information is returned. No errors occurred. |
| A | No information is returned. The job that called this API needs the authority specified in the object authorities field to the object. |
| D | The requested information is returned but may be incomplete. The object is damaged and should be deleted and created again as soon as possible. |
| L | No information is returned because the object is locked. |
| P | The requested information is returned. However, the object is partially damaged. In most instances, to recover from partial object damage, you delete the damaged object and either restore a saved copy or create the object again. For some damaged objects, special recovery procedures are possible. See the Recovering your system topic collection for more information about damaged objects. |
If two or more conditions occur that include no authorization (A) to the object, the status is set to A. If the object is damaged (D) and locked (L), or if the object is partially damaged (P) and locked, the status is set to L.
If the value of this field is A or L, your application should not use the other fields for the object. Only the object name, library, and type fields contain accurate data.
Key field for field returned. The specific key for the field being returned. See Valid Keys.
Length of data returned. The length of data returned for this keyed field.
Length of field information returned.The total length of information returned for this keyed field. This length includes the length of this field and all of the other fields in the structure returned for this key.
Number of fields returned. The number of keyed fields of information returned.
Object library name used. The name of the library that contains the object.
Object name used. The name of the object.
Object type used. The type of the object. For a list of all the available object types, see External object types.
Reserved. An unused field. This field contains hexadecimal zeros.
Type of data. The type of data that is contained in this keyed field. Possible values follow:
| B | Binary data |
| C | Character data |
| S | Special structured field used for key combinations. |
Valid Keys
The following table contains a list of the valid keys that are used for the key of fields to be returned parameter. See Field Descriptions for the descriptions of the valid key fields.
| Key | Type | Description |
|---|---|---|
| 0200 | CHAR(80) | Special key combination. See Key 0200 Contents for the key combination. |
| 0201 | CHAR(1) | Information status |
| 0202 | CHAR(10) | Extended object attribute |
| 0203 | CHAR(50) | Text description |
| 0204 | CHAR(10) | User-defined attribute |
| 0205 | BINARY(4) | Order in library list |
| 0300 | CHAR(144) | Special key combination. See Key 0300 Contents for the key combination. |
| 0301 | BINARY(4) | Object auxiliary storage pool (ASP) number |
| 0302 | CHAR(10) | Object owner |
| 0303 | CHAR(2) | Object domain |
| 0304 | CHAR(8) | Creation date and time |
| 0305 | CHAR(8) | Change date and time |
| 0306 | CHAR(10) | Storage |
| 0307 | CHAR(1) | Object compression status |
| 0308 | CHAR(1) | Allow change by program |
| 0309 | CHAR(1) | Changed by program |
| 0310 | CHAR(10) | Object auditing value |
| 0311 | CHAR(1) | Digitally signed |
| 0312 | CHAR(1) | Digitally signed by a system-trusted source |
| 0313 | CHAR(1) | Digitally signed more than once |
| 0314 | BINARY(4) | Library auxiliary storage pool (ASP) number |
| 0400 | CHAR(296) | Special key combination. See Key 0400 Contents for the key combination. |
| 0401 | CHAR(10) | Source file name |
| 0402 | CHAR(10) | Source file library name |
| 0403 | CHAR(10) | Source file member name |
| 0404 | CHAR(13) | Source file updated date and time |
| 0405 | CHAR(10) | Creator's user profile |
| 0406 | CHAR(8) | System where object was created |
| 0407 | CHAR(9) | System level |
| 0408 | CHAR(16) | Compiler |
| 0409 | CHAR(8) | Object level |
| 0410 | CHAR(1) | User changed |
| 0411 | CHAR(16) | Licensed program |
| 0412 | CHAR(10) | Program temporary fix (PTF) |
| 0413 | CHAR(10) | Authorized program analysis report (APAR) |
| 0414 | CHAR(10) | Primary group |
| 0415 | CHAR(1) | Optimum space alignment |
| 0416 | BINARY(4) | Primary associated space size |
| 0500 | CHAR(504) | Special key combination. See Key 0500 Contents for the key combination. |
| 0501 | CHAR(8) | Object saved date and time |
| 0502 | CHAR(8) | Object restored date and time |
| 0503 | BINARY(4) | Saved size |
| 0504 | BINARY(4) | Saved size multiplier |
| 0505 | BINARY(4) | Save sequence number |
| 0506 | CHAR(10) | Save command |
| 0507 | CHAR(71) | Save volume ID |
| 0508 | CHAR(10) | Save device |
| 0509 | CHAR(10) | Save file name |
| 0510 | CHAR(10) | Save file library name |
| 0511 | CHAR(17) | Save label |
| 0512 | CHAR(8) | Save active date and time |
| 0513 | CHAR(1) | Journal status |
| 0514 | CHAR(10) | Journal name |
| 0515 | CHAR(10) | Journal library name |
| 0516 | CHAR(1) | Journal images |
| 0517 | CHAR(1) | Journal entries to be omitted |
| 0518 | CHAR(8) | Journal start date and time |
| 0519 | CHAR(1) | Remote journal filter |
| 0600 | CHAR(548) | Special key combination. See Key 0600 Contents for the key combination. |
| 0601 | CHAR(8) | Last-used date and time |
| 0602 | CHAR(8) | Reset date and time |
| 0603 | BINARY(4) | Days-used count |
| 0604 | CHAR(1) | Usage information updated |
| 0605 | CHAR(10) | Object auxiliary storage pool (ASP) device name |
| 0606 | CHAR(10) | Library auxiliary storage pool (ASP) device name |
| 0700 | CHAR(560) | Special key combination. See Key 0700 Contents for the key combination. |
| 0701 | BINARY(4) | Object size |
| 0702 | BINARY(4) | Object size multiplier |
| 0703 | CHAR(1) | Object overflowed auxiliary storage pool (ASP) indicator |
| 0704 | CHAR(10) | Object auxiliary storage pool (ASP) group name |
| 0705 | CHAR(10) | Library auxiliary storage pool (ASP) group name |
| 0706 | CHAR(10) | Starting journal receiver name for apply |
| 0707 | CHAR(10) | Starting journal receiver library name |
| 0708 | CHAR(10) | Starting journal receiver library auxiliary storage pool (ASP) device name |
| 0709 | CHAR(10) | Starting journal receiver library auxiliary storage pool (ASP) group name |
| 0710 | CHAR(16) | Build identifier |
Key 0200 Contents
The following information is returned in the field when key 0200 is specified. For detailed descriptions of the subfields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Information status |
| 1 | 1 | CHAR(10) | Extended object attribute |
| 11 | B | CHAR(50) | Text description |
| 61 | 3D | CHAR(10) | User-defined attribute |
| 71 | 47 | BINARY(4) | Order in library list |
| 75 | 4B | CHAR(5) | Reserved |
Key 0300 Contents
the following information is returned in the field when key 0300 is specified. For detailed descriptions of the subfields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Everything from key 0200 | |
| 80 | 50 | BINARY(4) | Object auxiliary storage pool (ASP) number |
| 84 | 54 | CHAR(10) | Object owner |
| 94 | 5E | CHAR(2) | Object domain |
| 96 | 60 | CHAR(8) | Creation date and time |
| 104 | 68 | CHAR(8) | Change date and time |
| 112 | 70 | CHAR(10) | Storage |
| 122 | 7A | CHAR(1) | Object compression status |
| 123 | 7B | CHAR(1) | Allow change by program |
| 124 | 7C | CHAR(1) | Changed by program |
| 125 | 7D | CHAR(10) | Object auditing value |
| 135 | 87 | CHAR(1) | Digitally signed |
| 136 | 88 | CHAR(1) | Digitally signed by system-trusted source |
| 137 | 89 | CHAR(1) | Digitally signed more than once |
| 138 | 8A | CHAR(2) | Reserved |
| 140 | 8C | BINARY(4) | Library auxiliary storage pool (ASP) number |
Key 0400 Contents
The following information is returned in the field when key 0400 is specified. For detailed descriptions of the subfields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Everything from key 0300 | |
| 144 | 90 | CHAR(10) | Source file name |
| 154 | 9A | CHAR(10) | Source file library name |
| 164 | A4 | CHAR(10) | Source file member name |
| 174 | AE | CHAR(13) | Source file updated date and time |
| 187 | BB | CHAR(10) | Creator's user profile |
| 197 | C5 | CHAR(8) | System where object was created |
| 205 | CD | CHAR(9) | System level |
| 214 | D6 | CHAR(16) | Compiler |
| 230 | E6 | CHAR(8) | Object level |
| 238 | EE | CHAR(1) | User changed |
| 239 | EF | CHAR(16) | Licensed program |
| 255 | FF | CHAR(10) | Program temporary fix (PTF) |
| 265 | 109 | CHAR(10) | Authorized program analysis report (APAR) |
| 275 | 113 | CHAR(10) | Primary group |
| 285 | 11D | CHAR(2) | Reserved |
| 287 | 11F | CHAR(1) | Optimum space alignment |
| 288 | 120 | BINARY(4) | Primary associated space size |
| 292 | 124 | CHAR(4) | Reserved |
Key 0500 Contents
The following information is returned in the field when key 0500 is specified. For detailed descriptions of the subfields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Everything from key 0400 | |
| 296 | 128 | CHAR(8) | Object saved date and time |
| 304 | 130 | CHAR(8) | Object restored date and time |
| 312 | 138 | BINARY(4) | Saved size |
| 316 | 13C | BINARY(4) | Saved size multiplier |
| 320 | 140 | BINARY(4) | Save sequence number |
| 324 | 144 | CHAR(10) | Save command |
| 334 | 14E | CHAR(71) | Save volume ID |
| 405 | 195 | CHAR(10) | Save device |
| 415 | 19F | CHAR(10) | Save file name |
| 425 | 1A9 | CHAR(10) | Save file library name |
| 435 | 1B3 | CHAR(17) | Save label |
| 452 | 1C4 | CHAR(8) | Save active date and time |
| 460 | 1CC | CHAR(1) | Journal status |
| 461 | 1CD | CHAR(10) | Journal name |
| 471 | 1D7 | CHAR(10) | Journal library name |
| 481 | 1E1 | CHAR(1) | Journal images |
| 482 | 1E2 | CHAR(1) | Journal entries to be omitted |
| 483 | 1E3 | CHAR(8) | Journal start date and time |
| 491 | 1EB | CHAR(1) | Remote journal filter |
| 492 | 1EC | CHAR(12) | Reserved |
Key 0600 Contents
The following information is returned in the field when key 0600 is specified. For detailed descriptions of the subfields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Everything from key 0500 | |
| 504 | 1F8 | CHAR(8) | Last-used date and time |
| 512 | 200 | CHAR(8) | Reset date and time |
| 520 | 208 | BINARY(4) | Days-used count |
| 524 | 20C | CHAR(1) | Usage information updated |
| 525 | 20D | CHAR(10) | Object auxiliary storage pool (ASP) device name |
| 535 | 217 | CHAR(10) | Library auxiliary storage pool (ASP) device name |
| 545 | 221 | CHAR(3) | Reserved |
Key 0700 Contents
The following information is returned in the field when key 0700 is specified. For detailed descriptions of the subfields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Everything from key 0600 | |
| 548 | 224 | BINARY(4) | Object size |
| 552 | 228 | BINARY(4) | Object size multiplier |
| 556 | 22C | CHAR(1) | Object overflowed auxiliary storage pool (ASP) indicator |
| 557 | 22D | CHAR(10) | Object auxiliary storage pool (ASP) group name |
| 567 | 237 | CHAR(10) | Library auxiliary storage pool (ASP) group name |
| 577 | 241 | CHAR(10) | Starting journal receiver name for apply |
| 587 | 24B | CHAR(10) | Starting journal receiver library name |
| 597 | 255 | CHAR(10) | Starting journal receiver library auxiliary storage pool (ASP) device name |
| 607 | 25F | CHAR(10) | Starting journal receiver library auxiliary storage pool (ASP) group name |
| 617 | 269 | CHAR(16) | Build identifier |
| 633 | 279 | CHAR(3) | Reserved |
Field Descriptions
Allow change by program. Whether the object can be changed by the Change Object Description (QLICOBJD) API.
| 0 | The object cannot be changed with the QLICOBJD API. |
| 1 | The object can be changed with the QLICOBJD API. |
Authorized program analysis report (APAR). The identifier of the authorized program analysis report (APAR) that caused this object to be replaced. The field is blank if the object did not change because of an APAR.
Build identifier. The build identifier defined for the object. This field is set by IBM for objects built using Rational tools.
Changed by program. Whether the object has been changed by the Change Object Description (QLICOBJD) API.
| 0 | The object has not been changed with the QLICOBJD API. |
| 1 | The object has been changed with the QLICOBJD API. |
Change date and time. The time at which the object was last changed, in system time-stamp format.
Compiler. The licensed program identifier, version number, release level, and modification level of the compiler. The field has a pppppppVvvRrrMmm format, where:
| ppppppp | The licensed program identifier. |
| Vvv | The character V is followed by a 2-character version number. |
| Rrr | The character R is followed by a 2-character release level. |
| Mmm | The character M is followed by a 2-character modification level. |
The field is blank if it was not created with
a compiler.
Creation date and time. The time at which the object was created, in system time-stamp format. See Convert Date and Time Format (QWCCVTDT) API for more information about using this time-stamp format.
Creator's user profile. The name of the user that created the object.
Days-used count. The number of days the object was used. If the object does not have a last-used date, the count is 0.
Digitally signed. A 1-character variable that indicates whether the object has a digital signature.
| 0 | The object does not have a digital signature. |
| 1 | The object has a digital signature. |
Digitally signed by system-trusted source. A 1-character variable that indicates whether the object is signed by a source that is trusted by the system.
| 0 | None of the object signatures came from a source that is trusted by the system. |
| 1 | The object is signed by a source that is trusted by the system. If the object has multiple signatures, at least one of the signatures came from a source that is trusted by the system. |
Digitally signed more than once. A 1-character variable that indicates whether the object has more than one digital signature.
| 0 | The object has only one digital signature or does not have a digital signature. Refer to the digitally signed variable to determine whether the object has a digital signature. |
| 1 | The object has more than one digital signature. Refer to the digitally signed by system-trusted source variable to determine whether the object has a digital signature from a source trusted by the system. |
Extended object attribute. The extended attribute of the object, such as a program or file type. Extended attributes further describe the object. For example, an object type of *PGM may have a value of RPG (RPG program) or CLP (CL program), and an object type of *FILE may have a value of PF (physical file), LF (logical file), DSPF (display file), SAVF (save file), and so on.
Information status. Whether the QGYOLOBJ API returns the requested information for this object. If you do not request any keys to be returned, ignore this field. Possible values are:
| blank | The requested information is returned. No errors occurred. |
| A | No information is returned. The job that called this API needs the authority specified in the object authorities field to the object. |
| D | The requested information is returned but may be incomplete. The object is damaged and should be deleted and created again as soon as possible. |
| L | No information is returned because the object is locked. |
| P | The requested information is returned. However, the object is partially damaged. In most instances, to recover from partial object damage, you delete the damaged object and either restore a saved copy or create the object again. For some damaged objects, special recovery procedures are possible. See the Recovering your system topic collection for more information about damaged objects. |
If two or more conditions occur that include no authorization (A) to the object, the status is set to A. If the object is damaged (D) and locked (L), or if the object is partially damaged (P) and locked, the status is set to L.
If the value of this field is A or L, your application should not use the other fields for the object. Only the object name, library, and type fields contain accurate data.
Journal entries to be omitted. The journal entries to be omitted. The field is 1 if open and close operations do not generate open and close journal entries. The field is 0 if no entries are omitted. This field is blank if the object has never been journaled.
Journal images. The type of images that are written to the journal receiver for updates to the object. The field is 0 if only after images are generated for changes to the object. The field is 1 if both before and after images are generated for changes to the object. This field is blank if the object has never been journaled.
Journal library name. The name of the library that contains the journal. This field is blank if the object has never been journaled.
Journal name. The name of the current or last journal. This field is blank if the object has never been journaled.
Journal start date and time. The time at which journaling for the object was last started, in system time-stamp format. This field contains hexadecimal zeros if the object has never been journaled.
Journal status. The 1-character variable that returns the current journaling status of an object. The value is 1 if the object currently is being journaled; the value is 0 if the object currently is not being journaled.
Last-used date and time. The date and time at which the object was last used, in system time-stamp format. If the object has no last-used date, the field contains hexadecimal zeros.
Library auxiliary storage pool (ASP) device name. The name of the auxiliary storage pool (ASP) device where storage is allocated for the library that contains the object. The following special values may be returned:
| *N | The name of the ASP device cannot be determined. |
| *SYSBAS | System ASP (ASP 1) or defined basic user ASPs (ASPs 2-32) |
Library auxiliary storage pool (ASP) group name. The name of the auxiliary storage pool (ASP) group where storage is allocated for the library that contains the object. The name of the ASP group is the name of the primary ASP within the group. The following special values may be returned:
| *N | The name of the ASP device cannot be determined. |
| *SYSBAS | System ASP (ASP 1) or defined basic user ASPs (ASPs 2-32) |
Library auxiliary storage pool (ASP) number. The number of the auxiliary storage pool (ASP) where storage is allocated for the library that contains the object. Valid values are:
| 1 | System ASP |
| 2-32 | Basic user ASP |
| 33-255 | Primary or secondary ASP |
Licensed program. The name, version number, release
level, and modification level of the licensed program if the object
is part of a licensed program. The
field has a pppppppVvvRrrMmm format where:
| ppppppp | The licensed program identifier. |
| Vvv | The character V is followed by a 2-character version number. |
| Rrr | The character R is followed by a 2-character release level. |
| Mmm | The character M is followed by a 2-character modification level. |
The field is blank if the object is not a part of a licensed program.
Object auditing value. The type of auditing for an object. The valid values are:
| *NONE | No auditing occurs for this object when it is read or changed regardless of the user who is accessing the object. |
| *USRPRF | Audit this object only if the user accessing the object is being audited. The user profile for the job is tested to determine if auditing should be done for this object. The user profile can specify if only change access is audited or if both read and change accesses are audited for this object. |
| *CHANGE | Audit all change access to this object by all users on the system. |
| *ALL | Audit all access to this object by all users on the system. All access is defined as a read or change operation. |
| *NOTAVL | The auditing value is not available because you do not have either all object (*ALLOBJ) or audit (*AUDIT) special authority. |
Object auxiliary storage pool (ASP) device name. The name of the auxiliary storage pool (ASP) device where storage is allocated for the object. The following special values may be returned:
| *N | The name of the ASP device cannot be determined. |
| *SYSBAS | System ASP (ASP 1) or basic user ASPs (ASPs 2-32) |
Object auxiliary storage pool (ASP) group name. The name of the auxiliary storage pool (ASP) group where storage is allocated for the object. The name of the ASP group is the name of the primary ASP within the group. The value returned may be the same as the value returned for the object auxiliary storage pool (ASP) device name field. The following special values may be returned:
| *N | The name of the ASP device cannot be determined. |
| *SYSBAS | System ASP (ASP 1) or basic user ASPs (ASPs 2-32) |
Object auxiliary storage pool (ASP) number. The number of the auxiliary storage pool (ASP) where storage is allocated for the object. Valid values are:
| 1 | System ASP |
| 2-32 | Basic user ASP |
| 33-255 | Primary or secondary ASP |
Object compression status. Whether the object is compressed or decompressed. The status is returned with one of these values:
| Y | Compressed. |
| N | Permanently decompressed and compressible. |
| X | Permanently decompressed and not compressible. |
| T | Temporarily decompressed. |
| F | Saved with storage freed; compression status cannot be determined. |
Temporarily decompressed objects exist in both decompressed and compressed form. Permanently decompressed objects exist in decompressed form only. The system handles some decompression automatically, depending on the type of object, the operation performed on it, and its frequency of use. For an overview of object compression and decompression, see Object compression or decompression. For details about how to explicitly compress and decompress objects, see the online help for these commands: Compress Object (CPROBJ), Decompress Object (DCPOBJ), and Reclaim Temporary Storage (RCLTMPSTG).
Object domain. The domain that contains the object. Possible values follow:
| *S | The object is in the system domain. |
| *U | The object is in the user domain. |
Object level. The object control level for the created object.
Object overflowed auxiliary storage pool (ASP) indicator. Whether the object overflowed the auxiliary storage pool (ASP).
| 0 | The object has not overflowed the ASP. |
| 1 | The object overflowed the ASP in which it resides. |
For objects in the system auxiliary storage pool (ASP 1) or in a primary or secondary ASP (ASPs 33-255), a 0 is always returned because it is not possible for an object that resides in the system ASP or in a primary or secondary ASP to overflow its ASP.
Object owner. The name of the object owner's user profile.
Object restored date and time. The time at which the object was restored, in system time-stamp format. If the object has never been restored, the field contains hexadecimal zeros.
Object saved date and time. The time at which the object was saved, in system time-stamp format. If the object has never been saved, the field contains hexadecimal zeros.
Object size. The size of the object in units of the object size multiplier. The object size is equal to or smaller than the object size multiplied by the object size multiplier. The object size includes the value returned in the primary associated space size field (key 0416).
Object size multiplier. The value to multiply the object size by to get the object size in bytes.
The following values can be returned:
| 1 | The object size is smaller than 1 000 000 000 bytes. |
| 1024 | The object size is between 1 000 000 000 and 1 023 999 998 976 bytes. |
| 1048576 | The object size is larger than 1 023 999 998 976 bytes. |
Optimum space alignment. A 1-character variable that indicates whether the space associated with the object has been optimally aligned. Optimum alignment may allow for better performance of applications that use the object. The possible values are as follows:
| 0 | The space associated with the object has not been optimally aligned. |
| 1 | The space associated with the object has been optimally aligned. |
| 2 | There is not a space associated with the object. |
Order in library list. The order in which the library appears in the entire library list. If the library is in the library list more than once, the order of the first occurrence of the library is returned. If the library is not in the library list, then 0 is returned for the order number.
Primary associated space size. The size, in bytes, of the primary associated space used by the object. If the object does not have an associated space, the size is 0.
Primary group. The name of the user who is the primary group for the object. If no primary group exists for the object, this field contains a value of *NONE.
Program temporary fix (PTF). The number of the program temporary fix (PTF) number that caused this object to be replaced. This field is blank if the object was not changed because of a PTF.
Remote journal filter. The remote journal filter value for the object. The field is 1 if the journal entries for the object will be eligible for remote journal filtering by object. The field is 0 if the journal entries for the object will not be eligible for remote journal filtering by object. This field is blank if the object has never been journaled.
Reserved. An unused field. This field contains hexadecimal zeros.
Reset date and time. The date the days-used count was last reset to zero, in system time-stamp format. If the days-used count has never been reset, the field contains hexadecimal zeros.
Save active date and time. The date and time the object was last saved when the SAVACT(*LIB, *SYSDFN, or *YES) save operation was specified, in system time-stamp format. This parameter is found on the Save Library (SAVLIB), Save Object (SAVOBJ), Save Changed Object (SAVCHGOBJ), and Save Document Library Object (SAVDLO) CL commands. If the object has never been saved or if SAVACT(*NO) was specified on the last save operation for the object, the field contains hexadecimal zeros.
Save command. The command used to save the object. The field is blank if the object was not saved.
Save device. The type of device to which the object was last saved. The field is *SAVF if the last save operation was to a save file. The field is *DKT if the last save operation was to diskette. The field is *TAP if the last save operation was to tape. The field is *OPT if the last save operation was to optical. The field is blank if the object was not saved.
Save file library name. The name of the library that contains the save file if the object was saved to a save file. The field is blank if the object was not saved to a save file.
Save file name. The name of the save file if the object was saved to a save file. The field is blank if the object was not saved to a save file.
Save label. The file label used when the object was saved. The variable is blank if the object was not saved to tape, diskette, or optical. The value of the variable corresponds to the value specified for the LABEL parameter on the command used to save the object.
Save sequence number. The tape sequence number assigned when the object was saved on tape. The field contains zeros if the object was not saved.
Saved size. The size of the object in bytes of storage at the time of the last save operation. The saved size is equal to or smaller than the saved size multiplied by the saved size multiplier. The size includes the size of the primary associated space, if one exists. The field contains zeros if the object was not saved.
Saved size multiplier. The value to multiply the saved size by to get the saved size in bytes.
The following values can be returned:
| 1 | The saved size is smaller than 1 000 000 000 bytes. |
| 1024 | The saved size is between 1 000 000 000 and 1 023 999 998 976 bytes. |
| 1048576 | The saved size is larger than 1 023 999 998 976 bytes. |
Save volume ID. The tape, diskette, or optical volumes that are used for saving the object. The variable returns a maximum of ten 6-character volumes. The volume IDs begin in character positions 1, 8, 15, 22, 29, 36, 43, 50, 57, and 64. Each volume ID entry is separated by a single character. If the object was saved in parallel format, the separator character contains a 2 before the first volume in the second media file, a 3 before the third media file, and so on, up to a 0 before the tenth media file. Otherwise, the separator characters are blank. If more than 10 volumes are used and the object was saved in serial format, 1 is returned in the 71st character of the variable. If the object was saved in parallel format, a 2 is returned in the 71st character of the variable. Otherwise, the 71st character is blank. The field is blank if the object was last saved to a save file or if it was never saved.
Source file library name. The name of the library that contains the source file that is used to create the object. The field is blank if no source file created the object.
Source file member name. The name of the member in the source file. The field is blank if no source file created the object.
Source file name. The name of the source file that is used to create the object. The field is blank if no source file created the object.
Source file updated date and time. The date and time the member in the source file was last updated. This field is in the CYYMMDDHHMMSS format:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
| HH | Hour |
| MM | Minute |
| SS | Second |
The field is blank if no source file created the object.
Starting journal receiver library name. The name of the library that contains the starting journal receiver for apply. This field is blank if the object has never been journaled.
Starting journal receiver library auxiliary storage pool (ASP) device name. The name of the auxiliary storage pool (ASP) device where storage is allocated for the library that contains the starting journal receiver for apply. This field is blank if the object has never been journaled. The following special values may be returned:
| *N | The name of the ASP device cannot be determined. |
| *SYSBAS | System ASP (ASP 1) or defined basic user ASPs (ASPs 2-32) |
Starting journal receiver library primary auxiliary storage pool (ASP) group name. The name of the auxiliary storage pool (ASP) group where storage is allocated for the starting journal receiver library. The name of the ASP group is the name of the primary ASP within the group. The value returned may be the same as the value returned for the starting journal receiver library auxiliary storage pool (ASP) device name field. This field is blank if the object has never been journaled. The following special values may be returned:
| *N | The name of the ASP device cannot be determined. |
| *SYSBAS | System ASP (ASP 1) or defined basic user ASPs (ASPs 2-32) |
Starting journal receiver name for apply. The name of the oldest journal receiver needed to successfully use the Apply Journaled Changes (APYJRNCHG) or Remove Journaled Changes (RMVJRNCHG) command. This field is blank if the object has never been journaled.
For a file object, the journal receiver will contain the entry representing the start-of-the-save operation. However, if there are members within the file that contain partial transactions, then those members may require an earlier journal receiver. Use the Display File Description (DSPFD) command to determine the partial transaction state of the members of the file.
Storage. The storage status of the object data. *FREE indicates the object data is freed and the object is suspended. *KEEP indicates the object data is not freed and the object is not suspended.
System level. The level of the operating system when the object was created. The field has a VvvRrrMmm format, where:
| Vvv | The character V is followed by a 2-character version number. |
| Rrr | The character R is followed by a 2-character release level. |
| Mmm | The character M is followed by a 2-character modification level. |
System where object was created. The name of the system on which the object was created.
Text description. The text description of the object. The field is blank if no text description is specified.
Usage information updated. Whether the object usage information is updated for this object type. The indicator is returned as Y (Yes) or N (No).
User changed. Whether the user program was changed.
| 0 | The object was not changed by the user. |
| 1 | The user changed the object. |
User-defined attribute. A characteristic of an object type. This field is set by the user while using the Change Object Description (QLICOBJD) API.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPFB8ED E | Device description &1 not correct for operation. |
| CPF136A E | Job &3/&2/&1 not active. |
| CPF18BF E | Thread &1 not found. |
| CPF1867 E | Value &1 in list not valid. |
| CPF21AA E | Number of statuses must be between 1 and 5. |
| CPF21AB E | Status value &1 not valid. |
| CPF21AC E | Length or offset value &1 not valid. |
| CPF21A7 E | Authority value &1 not valid. |
| CPF21A8 E | Must specify *ANY as only authority value. |
| CPF21A9 E | Select or omit value &1 not valid. |
| CPF2173 E | Value for ASPDEV not valid with special value for library. |
| CPF218C E | &1 not a primary or secondary ASP. |
| CPF218D E | &1 not a primary ASP when *ASPGRP specified. |
| CPF22F7 E | Number of authorities must be between 1 and &1. |
| CPF22F9 E | Call level &1 not valid. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C3A E | Value for parameter &2 for API &1 not valid. |
| CPF3C3B E | Value for parameter &2 for API &1 not valid. |
| CPF3C31 E | Object type &1 is not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was 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. |
| 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. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9F81 E | API &1 requires too much information to be collected prior to sorting. |
| CPF980A E | &1 routine in &2 module detected an exception. The exception return code was &3. |
| CPF9804 E | Object &2 in library &3 damaged. |
| CPF9810 E | Library &1 not found. |
| CPF9814 E | Device &1 not found. |
| CPF9820 E | Not authorized to use library &1. |
| CPF9825 E | Not authorized to device &1. |
| CPF9830 E | Cannot assign library &1. |
| CPF9833 E | *CURASPGRP or *ASPGRPPRI specified and thread has no ASP group. |
| 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. |
| GUI0024 E | &1 is not valid for number of keys to sort on. |
| GUI0025 E | &1 is not valid for sort key field starting position. |
| GUI0026 E | &1 is not valid for sort key field length. |
| GUI0027 E | &1 is not valid for number of records to return. |
| GUI0083 E | &1 is not valid for number of fields to return. |
API introduced: V3R6
[ Back to top | Object APIs | APIs by category ]