Open List of Objects (QGYOLOBJ) API


  Required Parameter Group:


  Optional Parameter Group 1:


  Optional Parameter Group 2:


  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:

You can use the QGYOLOBJ API to:

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, Start of changeobject information is returned for the objects meeting the search criteria identified in the required parameter group. For all object types except user profiles (*USRPRF), the object is returned in the list of objects regardless of the authorizations you have for the object. For user profile (*USRPRF) objects, the object is returned in the list of objects only if you have some authority other than *EXCLUDE authority for the object. End of change 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 Security 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
Library authorities specified in the Authority control parameter. See note under Object 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.


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:

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.

  1. 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.

  2. 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.

  3. 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.

  4. 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:

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.

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. Start of change For all object types except user profiles (*USRPRF), 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. For user profile (*USRPRF) objects, the object is returned in the list of objects only if you have some authority other than *EXCLUDE authority for the object. End of change

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:


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.

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.



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.



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:

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:

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 .


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.

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.



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.



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:

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:

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.



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:

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.



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:

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:

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.



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:

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:



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 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.



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.

Start of change Note: The Authority collection value (key 0315) is not returned with the information for key 0300. End of change



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.



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.



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.



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.



Field Descriptions

Allow change by program. Whether the object can be changed by the Change Object Description (QLICOBJD) API.

Start of change Authority collection value. The authority collection value used for the object when authority collection for objects is active on the partition. A value of *NONE will be returned if the object type is not supported by authority collection. The valid values are:

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.

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:

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.

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.

Digitally signed more than once. A 1-character variable that indicates whether the object has more than one digital signature.

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:

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:

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:

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:

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:

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:

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:

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:

Object auxiliary storage pool (ASP) number. The number of the auxiliary storage pool (ASP) where storage is allocated for the object. Valid values are:

Object compression status. Whether the object is compressed or decompressed. The status is returned with one of these values:

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:

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).

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:

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:

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:

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:

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:

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:

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:

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.

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



API introduced: V3R6

[ Back to top | Object APIs | APIs by category ]