ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qtaupddv.htm

289 lines
7.6 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 Device Microcode(QTAUPDDV) 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 VxRy on YYMMDD by INITIALS -->
<!-- Change history: -->
<!-- 040107 J Kochan create -->
<!-- 040420 R Tilbury Fixed Error messages, Authorities -->
<!-- and some wording in the description. -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2><img src="delta.gif" alt="Start of change">Update Device Microcode (QTAUPDDV) API</h2>
<div class="box" style="width: 90%;">
<br>
&nbsp;&nbsp;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%">Device name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">2</td>
<td align="left" valign="top" width="50%">Source path name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Optional Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">3</td>
<td align="left" valign="top" width="50%">Length of source path name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Format Name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">5</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>
&nbsp;&nbsp;Default Public Authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Update Device Microcode (QTAUPDDV) API provides an interface for updating device microcode from a code image stored in an Integrated File System (IFS) stream file. </p>
<p>The QTAUPDDV API only supports self-configuring, stand alone tape devices. The Retrieve Device Capabilities (QTARDCAP) API can be used to determine if the tape device is a self-configured tape device. Other types of devices are currently not supported by this API. This API can be used for a tape device within a media library if the device is deallocated from the library.</p>
<p><strong>Note:</strong> Incorrect use of this API can cause damage to the tape device.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE</dd>
<dt><em>Special Authority</em></dt>
<dd>*SERVICE</dd>
<dt><em>Directory Access Authority</em></dt>
<dd>*X</dd>
<dt><em>Stream File Access Authority</em></dt>
<dd>*R</dd>
<dt><em>Device Description Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>Device Description Lock</em></dt>
<dd>*EXCLRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Device name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the device for which for which the code image is to be updated.</p>
</dd>
<dt><strong>Source path name.</strong></dt>
<dd>INPUT; CHAR(*)
<p>The path name for the code image.</p>
</dd>
</dl>
<br>
<h3>Optional Parameter Group</h3>
<dl>
<dt><strong>Length of source path name.</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the source path name provided. Valid values range from 1 through 32048 or -1. If this parameter is omitted, the source path name is assumed to be a simple blank terminated path name. Use -1 if the length is in the LG-type structure. </p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the source path name parameter. If this parameter is omitted the source path name is assumed to be a simple blank terminated path name in the current CCSID.</p>
<dl>
<dt><strong>TAUD0100</strong></dt>
<dd>The source path name is a simple path name in the current CCSID.<br>
<br>
</dd>
<dt><strong>TAUD0200</strong></dt>
<dd>The source path name is a LG-type path name structure. For more information on this structure, see <a href="../apiref/pns.htm">Path name format</a>.<br>
<br>
</dd>
</dl>
</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>. If this parameter is omitted, any problems will result in escape messages to the application.</p>
</dd>
</dl>
<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">CPFA0A9 E</td>
<td width="85%" valign="top">Object not found. Object is *.</td>
</tr>
<tr>
<td width="15%" valign="top">CPFA09C E</td>
<td width="85%" valign="top">Not authorized to object.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF222E E</td>
<td width="85%" valign="top">* special authority is required.</td>
</tr>
<tr>
<td width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td valign="top">CPF3C1D E</td>
<td valign="top">Length specified in parameter * not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C21 E</td>
<td valign="top">Format name * is not valid.</td>
</tr>
<tr>
<td valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td valign="top">CPF6B35 E</td>
<td valign="top">File member is in use.</td>
</tr>
<tr>
<td valign="top">CPF6708 E</td>
<td valign="top">Command ended due to error.</td>
</tr>
<tr>
<td valign="top">CPF671F E</td>
<td valign="top">Parameter list not correct.</td>
</tr>
<tr>
<td valign="top">CPF67C2 E</td>
<td valign="top">Path name structure field * not valid.</td>
</tr>
<tr>
<td valign="top">CPF67C8 E</td>
<td valign="top">Command faild for device *. Reason code *.</td>
</tr>
<tr>
<td valign="top">CPF8068 E</td>
<td valign="top">Error detected while processing file.</td>
</tr>
<tr>
<td valign="top">CPF9802 E</td>
<td valign="top">Not authorized to object * in *.</td>
</tr>
<tr>
<td valign="top">CPF9814 E</td>
<td valign="top">Device &amp;1 not found.</td>
</tr>
</table>
<img src="deltaend.gif" alt="End of change">
<br>
<hr>
API introduced: V5R4
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="back1.htm">Miscellaneous APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>