454 lines
13 KiB
HTML
454 lines
13 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>Add View File (QteAddViewFile) 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. -->
|
|
<!-- DEBUG1 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 29 Jan 1999 at 16:05:09 -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!--File Edited November 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>Add View File (QteAddViewFile) API</h2>
|
|
|
|
<div class="box" style="width: 60%;"><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%">File descriptor 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">Number of entries</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">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">4</td>
|
|
<td align="left" valign="top">View number</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Binary(4)</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Service Program: QTECRTVS<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: No<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Add View File (QteAddViewFile) API provides a list of files that can be
|
|
used when describing text for a previously added view. If a file is read more
|
|
than once (such as a multiple included file), it should be added multiple
|
|
times. When this file needs to be identified to other APIs, its file index is
|
|
given, which is an index into the list of files supplied. The first file
|
|
supplied has an index of zero.</p>
|
|
|
|
<p>The first file added to a view must be the root file for that view. For
|
|
example, if a processor produces a source view, where a root file includes
|
|
other files, the root file must be specified as the first file for the view.
|
|
This is true even if the file is not the first file to produce view text (which
|
|
would happen if an include statement is on the first line of the file).</p>
|
|
|
|
<p>All files for a view must be added at one time, with one call to this
|
|
API.</p>
|
|
|
|
<br>
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<!-- Use this if there are no authorities and locks. -->
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>File descriptor buffer</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The input variable containing the list of files that make up the
|
|
specified view text.</p>
|
|
|
|
<p>The source debugger support does not validate the existence of this file.
|
|
This validation is done when text from the file is retrieved.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Number of entries</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number of files that are provided in the file descriptor
|
|
buffer parameter.</p>
|
|
|
|
<p>Many files may be described in a single file descriptor buffer. However,
|
|
each entry must represent a single file, and this parameter must be a count of
|
|
the number of files provided.</p>
|
|
|
|
<p>For format FILA0200, the number specifies the number of format entries, each
|
|
containing seven fields, that are present before the external file names
|
|
buffer.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The content and format of the information supplied by the calling
|
|
program in the file descriptor buffer. The valid values for format name
|
|
are:</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>FILA0100</em></td>
|
|
<td align="left" valign="top">i5/OS file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>FILA0200</em></td>
|
|
<td align="left" valign="top">External file (workstation file not on an iSeries
|
|
server) or i5/OS integrated file system file</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>For more information, see <a href="#HDRFIL1">FILA0100 Format</a> or <a href=
|
|
"#HDRFIL2">FILA0200 Format</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>View number</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The number assigned by the debug support as an output parameter on
|
|
the Add View Description API, which must be called prior to this API. If a file
|
|
is used for more than one view, it must be supplied once for each view in which
|
|
it is used.</p>
|
|
|
|
<br>
|
|
</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="HDRFIL1">FILA0100 Format</a></h3>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">CHAR(10)</td>
|
|
<td align="left" valign="top" width="60%">i5/OS file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="center" valign="top">A</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">i5/OS file library</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">i5/OS member name</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRFIL2">FILA0200 Format</a></h3>
|
|
|
|
<table border width="80%">
|
|
<!-- cols="10 10 20 60" -->
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="BOTTOM">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The first
|
|
seven fields repeat the number of times specified in the number of entries
|
|
parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%"> </td>
|
|
<td align="center" valign="top" width="10%"> </td>
|
|
<td align="left" valign="top" width="20%">BINARY(4)</td>
|
|
<td align="left" valign="top" width="60%">Offset of file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Length of file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">File flag</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">CCSID of file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(2)</td>
|
|
<td align="left" valign="top">Country or region ID of file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Language ID of file name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The following
|
|
field occurs after the preceding header fields.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">CHAR(*)</td>
|
|
<td align="left" valign="top">File names buffer</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
<h3><a name="HDRADDVFFD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>i5/OS file library.</strong> The name of the library that contains
|
|
the file being listed. It is an i5/OS object name, left-justified, and padded
|
|
with blanks.</p>
|
|
|
|
<p><strong>i5/OS file name.</strong> The name of the i5/OS file being listed.
|
|
It is an i5/OS object name, left-justified, and padded with blanks.</p>
|
|
|
|
<p><strong>i5/OS member name.</strong> The name of the member in the file
|
|
being listed. It is an i5/OS object name, left-justified, and padded with
|
|
blanks.</p>
|
|
|
|
<p><strong>CCSID of file name.</strong> The CCSID the file name is in. A value
|
|
of zero indicates to use the CCSID value of the job. A value of 65 535
|
|
causes an error message to be sent and the request to be ended.</p>
|
|
|
|
<p><strong>Country or region ID of file name.</strong> The country or region ID
|
|
of the file name. A value of blanks indicates that the country or region ID of
|
|
job should be used.</p>
|
|
|
|
<p><strong>File flag.</strong> Whether the file is an i5/OS integrated file
|
|
system file or an external file (a workstation file not on an iSeries
|
|
server).</p>
|
|
|
|
<table cellpadding="3">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">External file</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>1</em></td>
|
|
<td align="left" valign="top">i5/OS integrated file system file</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>File names buffer.</strong> The names of external files or i5/OS
|
|
integrated file system files being listed. The file names are laid out one
|
|
after another in this buffer. There is a pair of offset and length fields for
|
|
each file name in this buffer.</p>
|
|
|
|
<p><strong>Language ID of file name.</strong> The language ID of the file name.
|
|
A value of blanks indicates to use the language ID value of the job.</p>
|
|
|
|
<p><strong>Length of file name.</strong> This is the length in bytes of the
|
|
external file name in the external file names buffer.</p>
|
|
|
|
<p><strong>Offset of file name.</strong> This offset from the start of the file
|
|
descriptor buffer specifies the start of an external file name.</p>
|
|
|
|
<p><strong>Reserved.</strong> Reserved for future use.</p>
|
|
|
|
<br>
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top" nowrap>Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is not valid.</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">CPF9542 E</td>
|
|
<td align="left" valign="top">View not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9549 E</td>
|
|
<td align="left" valign="top">Error addressing API parameter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9556 E</td>
|
|
<td align="left" valign="top">API not valid at this time.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9558 E</td>
|
|
<td align="left" valign="top">View already contains file descriptors.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF955B E</td>
|
|
<td align="left" valign="top">Number of entries not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF955D E</td>
|
|
<td align="left" valign="top">View data overflow. All debug data lost.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF956B E</td>
|
|
<td align="left" valign="top">File name length not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF956C E</td>
|
|
<td align="left" valign="top">File name offset not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9575 E</td>
|
|
<td align="left" valign="top">File flag not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9581 E</td>
|
|
<td align="left" valign="top">CCSID of file name parameter not valid.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<hr>
|
|
API introduced: V3R1
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#top_Of_Page">Top</a> | <a href=
|
|
"debug1.htm">Debugger APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|