Object-related APIs

You can use object-related APIs to obtain information about IBM^® i objects.

The QUSLOBJ and QUSROBJD APIs return much of the same information. The APIs differ, however, in several respects:

• The APIs group the returned information differently among their output formats. For example, the OBJL0300 format of the QUSLOBJ API does not contain exactly the same data as the OBJD0300 format of the QUSROBJD API.
  
  
• The APIs use different data formats for some specific items, such as dates and times.
  
  
• The APIs differ in efficiency, depending on your application. In most cases, the QUSROBJD API is faster at retrieving information about a single object. The QUSLOBJ API is faster at retrieving information about several objects.

The object-related APIs are:

• Change Library List (QLICHGLL) changes the current library, the two product libraries, and the user part of the job's library list.
• Change Object Description (QLICOBJD) changes object information for a specific object, similar to the Change Object Description (CHGOBJD) command.
• Convert Type (QLICVTTP) converts an object type to and from hexadecimal format.
• Delete Object (QLIDLTO) deletes objects of an object type listed in the description of the object type parameter.
• List Objects (QUSLOBJ) generates a list of object names and descriptive information based on the specified parameters, similar to the Display Object Description (DSPOBJD) command.
• Materialize Context (QusMaterializeContext) returns either the type and subtype of the object or system pointers for all or for a selected set of objects that are contained by the context.
• Move Folder to ASP (QHSMMOVF) moves a root folder and its contents from its existing auxiliary storage pool (ASP) to the specified target ASP through a save and restore process.
• Move Library to ASP (QHSMMOVL) moves a library and its contents from its existing auxiliary storage pool (ASP) to the specified target ASP through a save and restore process.
• Open List of Objects (QGYOLOBJ) generates a list of object names and descriptive information based on specified selection parameters.
• Rename Object (QLIRNMO) renames an existing object to a new object name or new library name or both and optionally replaces the object, combining the functions of the Rename Object (RNMOBJ) and the Move Object (MOVOBJ) commands.
• Retrieve Library Description (QLIRLIBD) retrieves attributes for a specific library, similar to the Retrieve Library Description (RTVLIBD) command.
• Retrieve Object Description (QUSROBJD) retrieves object information for a specific object, similar to the Retrieve Object Description (RTVOBJD) command.

---

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