| 1 | Application information path name | Input | Char(*) |
| 2 | Function | Input | Binary(4) |
| 3 | Error code | I/O | Char(*) |
The Update IBM® i Registered Application Information Repository (QSZUPDRA, QszUpdRegAppInfoRepository) API updates information about one or many separately installable pieces of an application called components. Each piece of information about each component is stored as a tag and a value. This API can be used to:
The flexibility of this API allows it to define all information for a component or a set of components in a single call since any number of components and tags may be specified in the same call.
It also can be used to remove a set of tags for a given component or it can even remove a set of components.
Be aware that this API should not be used to update information that belongs to IBM i packaged products including the IBM i Operating System. Information in the IBM i Registered Application Information Repository is automatically updated by the system when a user installs an IBM i packaged product using the Restore Licensed Program (RSTLICPGM) command or when the user deletes the product using the Delete Licensed Program (DLTLICPGM) command. If the user tries to update information for an IBM i packaged product, an error will occur.
The path name of the object which contains the XML document with the information of the components to be updated by the API. This may be a path to a user space (*USRSPC) or a path to a stream file (*STMF). The path name must be specified in the Qlg_Path_Name_T format. If a pointer is specified in the path name format, it must be 16-byte aligned. If not, unpredictable results may occur. For more information on this structure, see Path name format. The information contained in this object should be given to the API as an XML document according to the data type definition (DTD). For a detailed description of the DTD, see XML document when updating.
Depending on the function requested, some of the tags may be optional. For example, to remove all information related to a specific component, you have to specify the remove function and only the component information; that is, product name, version, component name, instance, feature and vendor. The API removes the component from the repository along with its associated information.
The function to perform. The possible function values are:
| 1 | The Add or Update function. The API adds or updates
information in the IBM i Registered Application Information Repository. The
following actions may occur in the same call:
|
| 2 | The Remove function. The API removes the tag or tags specified corresponding to the component from the IBM i Registered Application Information Repository. If no tags are specified for the component, the component and all its associated information is removed. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
This object may be a stream file (*STMF) or a user space (*USRSPC) object. In either case, the contents of the object must be an XML document that conforms to the specified rules.
All elements and attributes defined in the data type definition (DTD) are allowed when using this API. See Software components DTD for a detailed description of each element. The examples below illustrate the way to define an XML document to call this API.
When a component is being registered, use function add/update (1).
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE RegAppInfoRepository SYSTEM "/QIBM/XML/DTD/QszRegAppInfoRepository.dtd">
<RegAppInfoRepository DTDVersion="1.0">
<Component ProductName="My compiler" ComponentVersion="v1.1.0" ComponentName="Tools"
ComponentVendor="Juan Perez" FeatureName="Juan Perez">
</Component>
</RegAppInfoRepository>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE RegAppInfoRepository SYSTEM "/QIBM/XML/DTD/QszRegAppInfoRepository.dtd">
<RegAppInfoRepository DTDVersion="1.0">
<Component ProductName="My tools" ComponentVersion="v1.1.0" ComponentName="Edit"
Instance="/ProgramFiles/MyTools" ComponentVendor="Juan Perez">
<ExtendedData UninstallInfo="java /ProgramFiles/MyTools/MyUninstaller"
LastFixPackApplied="2.0" InstallerType="ISJE" Supported="0"
Installed="1" CCSID="00037">
<Shared>
<SharingComponent ProductName="My compiler" ComponentVersion="v1.1.0"
ComponentName="EditTools" ComponentVendor="Pedro Fernandez"/>
</Shared>
<Files>
<Directory DirectoryName="/ProgramFiles/MyTools/MyUninstaller/bin">
<FileName>edit1.exe</FileName>
<FileName>edit2.exe</FileName>
<FileName>edit3.exe</FileName>
<FileName>edit4.exe</FileName>
<FileName>edit5.exe</FileName>
</Directory>
</Files>
<AdditionalValue ValueName="InstallType" Value="Custom"/>
<AdditionalValue ValueName="InstallDate" Value="05/10/1999"/>
</ExtendedData>
</Component>
</RegAppInfoRepository>
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9872 E | Program or service program &1 in library &2 ended. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF0CC1 E | Error initializing the XML parser. |
| CPF0CC2 E | Error found on XML input document. |
| CPF0CC7 E | Requested function not successful. |
| CPF0CC6 E | Not all components were successfully updated. |
| CPF0CC4 E | Value &1 for function parameter not valid. |
| CPF0CD2 E | Application information path name not valid. |