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

191 lines
5.1 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>Write Build Information (QLYWRTBI) 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. -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited by Kersten Oct 2001 -->
<!--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>Write Build Information (QLYWRTBI) API</h2>
<div class="box" style="width: 60%;">
<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%">Buffer</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">Buffer length</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Write Build Information (QLYWRTBI) API writes one or more records to the
space.</p>
<p>QLYWRTBI writes records to the space concatenated to each other. QLYRDBI
later reads them sequentially in the order in which they are written.</p>
<p>QLYWRTBI continues to write records to the API space concatenated to
previous records written, until QLYSETS is called. See <a href="hll1a.htm">Record
Types</a> for the records that can be written. See <a href="hll1b.htm">Examples of
Records Written</a> for examples of the sequence of records written.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Buffer</strong></dt>
<dd>INPUT; CHAR(*)
<p>A character string containing one or more records of build information.</p>
</dd>
<dt><strong>Buffer length</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the buffer in bytes. The buffer length must be equal to the
sum of the lengths of all the concatenated records being passed, otherwise an
error occurs.</p>
</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>
<p>The first field in each record indicates the record length. This allows all
the records to be read sequentially using the QLYRDBI API.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">LIB9002</td>
<td width="85%" valign="top">Value specified for the buffer length parameter is
not valid.</td>
</tr>
<tr>
<td align="left" valign="top">LIB9003</td>
<td align="left" valign="top">Value specified for the buffer length parameter is too
small.</td>
</tr>
<tr>
<td align="left" valign="top">LIB9004</td>
<td align="left" valign="top">Record not in correct sequence.</td>
</tr>
<tr>
<td align="left" valign="top">LIB9008</td>
<td align="left" valign="top">Record has a record type that is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">LIB9009</td>
<td align="left" valign="top">Build information space does not exist, or it is damaged or
deleted.</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">CPF3C90 E</td>
<td align="left" valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library &amp;2 ended.
Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V2R2
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center"><td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="hll.htm">High-level language APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>