367 lines
11 KiB
HTML
367 lines
11 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Update i5/OS Registered Application Information Repository (QSZUPDRA,
|
||
|
|
QszUpdRegAppInfoRepository) API</title>
|
||
|
|
<!-- Begin Header Records -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Created for V5R1 -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- Edited by Kersten Jan 02 -->
|
||
|
|
<!-- Edited by James Masanz July 03 -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!--Java sync-link-->
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Update i5/OS Registered Application Information Repository (QSZUPDRA,
|
||
|
|
QszUpdRegAppInfoRepository) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 80%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Application information path
|
||
|
|
name</td>
|
||
|
|
<td align="left" valign="top" width="20%">Input</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Function</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Error code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Service Program Name: QSZRAIRA<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *EXCLUDE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The Update i5/OS 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:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>Define a new component.</li>
|
||
|
|
|
||
|
|
<li>Update a tag defined for a component.</li>
|
||
|
|
|
||
|
|
<li>Add a new tag for the component.</li>
|
||
|
|
|
||
|
|
<li>Remove a tag from the component.</li>
|
||
|
|
|
||
|
|
<li>Remove a component and all its associated information (tags).</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
|
||
|
|
<p>It also can be used to remove a set of tags for a given component or it can
|
||
|
|
even remove a set of components.</p>
|
||
|
|
|
||
|
|
<p>Be aware that this API should not be used to update
|
||
|
|
information that belongs to i5/OS packaged products including the i5/OS
|
||
|
|
Operating System. Information in the i5/OS Registered Application
|
||
|
|
Information Repository is automatically updated by the system when a user
|
||
|
|
installs an i5/OS 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 i5/OS packaged product, an error will occur.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>Library Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXECUTE<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Authority for user space containing XML document</em></dt>
|
||
|
|
|
||
|
|
<dd>*USE<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>User Space Lock</em></dt>
|
||
|
|
|
||
|
|
<dd>*EXCLRD<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Stream File Directory Authority</em></dt>
|
||
|
|
|
||
|
|
<dd>*RX<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><em>Authority for Stream File containing XML document</em></dt>
|
||
|
|
|
||
|
|
<dd>*R</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Application information path name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>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 <a href="../apiref/pns.htm">Path name
|
||
|
|
format</a>. 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 <a href="#HDRSZUPDAP">"XML Document when
|
||
|
|
updating"</a>.</p>
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Function</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The function to perform. The possible function values are:</p>
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 90" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>1</em></td>
|
||
|
|
<td align="left" valign="top">The Add or Update function. The API adds or updates
|
||
|
|
information in the i5/OS Registered Application Information Repository. The
|
||
|
|
following actions may occur in the same call:
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>If the component specified does not exist, the component and all
|
||
|
|
the tag(s) associated with it are added.</li>
|
||
|
|
|
||
|
|
<li>If the component already exists in the repository but its associated tags
|
||
|
|
do not exist, the tags are added.</li>
|
||
|
|
|
||
|
|
<li>If the component exists and its tags already exist, the tags
|
||
|
|
are updated with their new values.</li>
|
||
|
|
</ul>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>2</em></td>
|
||
|
|
<td align="left" valign="top">The Remove function. The API removes the tag or tags
|
||
|
|
specified corresponding to the component from the i5/OS Registered Application Information Repository. If no tags are specified for the
|
||
|
|
component, the component and all its associated information is removed.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="HDRSZUPDAP">XML Document when updating</a></h3>
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
|
||
|
|
<p>All elements and attributes defined in the data type definition (DTD) are
|
||
|
|
allowed when using this API. See <a href="softwarecompdtd.htm">Software
|
||
|
|
Components DTD</a> for a detailed description of each element. The examples
|
||
|
|
below illustrate the way to define an XML document to call this API.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Register only the component with no additional data.</h4>
|
||
|
|
|
||
|
|
<p>When a component is being registered, use function add/update (1).</p>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<?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>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h4>Use one call to register and store all information related to a
|
||
|
|
component.</h4>
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
<?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>
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Messages</h3>
|
||
|
|
|
||
|
|
<table width="100%" cellpadding="5">
|
||
|
|
<!-- cols="15 85" -->
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">CPF24B4 E</td>
|
||
|
|
<td width="85%" valign="top">Severe error addressing parameter list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
||
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
||
|
|
<td align="left" valign="top">Error(s) occurred during running of &1
|
||
|
|
API.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF9872 E</td>
|
||
|
|
<td align="left" valign="top">Program or service program &1 in library
|
||
|
|
&2 ended.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF3C1E E</td>
|
||
|
|
<td align="left" valign="top">Required parameter &1 omitted.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0CC1 E</td>
|
||
|
|
<td align="left" valign="top">Error initializing the XML parser.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0CC2 E</td>
|
||
|
|
<td align="left" valign="top">Error found on XML input document.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0CC7 E</td>
|
||
|
|
<td align="left" valign="top">Requested function not successful.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0CC6 E</td>
|
||
|
|
<td align="left" valign="top">Not all components were successfully
|
||
|
|
updated.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0CC4 E</td>
|
||
|
|
<td align="left" valign="top">Value &1 for function parameter not
|
||
|
|
valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">CPF0CD2 E</td>
|
||
|
|
<td align="left" valign="top">Application information path name not valid.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"sw1.htm">Software Product APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|