ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/readfile.htm

256 lines
8.8 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">
<title>Read a File (READFILE)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="READFILE.Top_Of_Page"></a>
<h2>Read a File (READFILE)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>
<ul><li>Batch job (*BATCH)</li>
<li>Interactive job (*INTERACT)</li>
<li>Batch REXX procedure (*BREXX)</li>
<li>Interactive REXX procedure (*IREXX)</li>
</ul><b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#READFILE.PARAMETERS.TABLE">Parameters</a><br>
<a href="#READFILE.COMMAND.EXAMPLES">Examples</a><br>
<a href="#READFILE.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="READFILE"></a>
<h3>.. READFILE Control Stmnt</h3>
<p>Use the .. READFILE control statement to include a new file in the input stream. This control statement can be placed in a command file, issued using direct-workstation input, or issued from the RJE console.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="READFILE.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#READFILE.FILE"><b>FILE</b></a></td>
<td valign="top">Input file</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Input file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#READFILE.MBR"><b>MBR</b></a></td>
<td valign="top">Member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b>, *ALL</td>
<td valign="top">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#READFILE.CMD"><b>CMD</b></a></td>
<td valign="top">Command file</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#READFILE.SNDDLTRCD"><b>SNDDLTRCD</b></a></td>
<td valign="top">Send deleted records</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#READFILE.DTATYP"><b>DTATYP</b></a></td>
<td valign="top">Data type</td>
<td valign="top"><b><u>*CHAR</u></b>, *ANY</td>
<td valign="top">Optional, Positional 5</td>
</tr>
<tr>
<td valign="top"><a href="#READFILE.RLS"><b>RLS</b></a></td>
<td valign="top">Release Control</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 6</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#READFILE.MSGQ"><b>MSGQ</b></a></td>
<td valign="top">Message queue</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 7</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Message queue</td>
<td valign="top"><i>Name</i>, <b><u>*PRV</u></b>, *NONE, *RDRE</td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr></table>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="READFILE.FILE"></a>
<h3>Input File (FILE)</h3>
<p>Specifies the qualified name of the file that contains the input stream being included.
</p>
<p>The possible library values are:
</p>
<ul>
<li>*LIBL: The library list for the job is used to locate the file.
</li>
<li>*CURLIB: The current library for the job is used to locate the file. If no current library is specified, QGPL is used.
</li>
<li><i>library-name:</i> Specify the name of the library where the file is located.
</li>
</ul>
<p><i>database-file-name:</i> Specify the name of the database file that contains the input stream.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="READFILE.MBR"></a>
<h3>Member (MBR)</h3>
<p>Specifies the database file member being sent to the host subsystem.
</p>
<p>The possible values are:
</p>
<ul>
<li>*FIRST: The first member of the database file is sent to the host subsystem.
</li>
<li>*ALL: All members of the database file are sent to the host subsystem.
</li>
<li><i>member-name:</i> Specify the member name of the database file. If the member does not exist, an inquiry message is sent to the RJE message queue.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="READFILE.CMD"></a>
<h3>Command File</h3>
<p>Specifies whether the file specified in the FILE parameter is searched for embedded RJE control statements.
</p>
<p>The possible values are:
</p>
<ul>
<li>*NO: The file is not searched. Records are re-blocked to 80-byte records.
</li>
<li>*YES: The file is searched. Records longer than 80 bytes are truncated.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="READFILE.SNDDLTRCD"></a>
<h3>Send Del Records (SNDDLTRCD)</h3>
<p>Specifies whether blank records are sent to the host subsystem when deleted records are found in the database file member.
</p>
<p>The possible values are:
</p>
<ul>
<li>*NO: Blank records are not sent.
</li>
<li>*YES: Blank records are sent.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="READFILE.DTATYP"></a>
<h3>Data Type (DTATYP)</h3>
<p>Specifies whether the file specified in the FILE parameter contains data characters less than hex 40.
</p>
<p>The possible values are:
</p>
<ul>
<li>*CHAR: The file does not contain data characters less than hex 40.
</li>
<li>*ANY: The file does contain data characters less than hex 40.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="READFILE.RLS"></a>
<h3>Release Control (RLS)</h3>
<p>Specifies whether RJE will process the rest of the current file (that is, the file from which .. READFILE was issued) after the included file is processed. If not, the file is released from the nested stack of the files being read.
</p>
<p>The possible values are:
</p>
<ul>
<li>*NO: RJE will continue to process the current file after the included file is processed.
</li>
<li>*YES: RJE will not process the current file after the included file is processed. Processing reverts to the previous file. In other words, the current file is released from the nested stack of files. This improves performance, as each file left open in a nested stack has an impact on system resources. Do not specify *YES if this control statement is entered using direct-workstation input.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="READFILE.MSGQ"></a>
<h3>Message Queue (MSGQ)</h3>
<p>Specifies the qualified name of the message queue to which messages for the reader are sent.
</p>
<p>The possible values are:
</p>
<ul>
<li>*PRV: The message queue specified with the previous .. READFILE control statement is used.
</li>
<li>*NONE: A message queue is not used.
</li>
<li>*RDRE: The message queue name is retrieved from the session description reader entry.
</li>
</ul>
<p>The possible library values are:
</p>
<ul>
<li>*LIBL: The library list for the job is used to locate the message queue.
</li>
<li>*CURLIB: The current library for the job is used to locate the message queue. If no current library is specified, QGPL is used.
</li>
<li><i>library-name:</i> Specify the name of the library where the message queue is located.
</li>
</ul>
<p><i>message-queue-name:</i> Specify the name of the message queue.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="READFILE.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="READFILE.ERROR.MESSAGES">Error messages</a></h3>Unknown
</div>
<table width="100%">
<tr><td align="right"><a href="#READFILE.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>