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

352 lines
12 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>Copy From PC Document (CPYFRMPCD)</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="CPYFRMPCD.Top_Of_Page"></a>
<h2>Copy From PC Document (CPYFRMPCD)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#CPYFRMPCD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CPYFRMPCD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CPYFRMPCD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CPYFRMPCD"></a>
<p>The Copy From PC Document (CPYFRMPCD) command copies the data in a PC document to a system database file.
</p>
<p>
<b>Note: </b>Do not precede an entry with an asterisk unless that entry is a "special value" that is shown (on the display itself or in the help information) with an asterisk.
</p>
<h3>Error messages for CPYFRMPCD</h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>IWS1603</b></dt>
<dd>PC document copied to file with &amp;6 truncated records.
</dd>
<dt><b>IWS1611</b></dt>
<dd>PC document &amp;1 not copied.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CPYFRMPCD.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"><a href="#CPYFRMPCD.FROMFLR"><b>FROMFLR</b></a></td>
<td valign="top">From folder</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CPYFRMPCD.TOFILE"><b>TOFILE</b></a></td>
<td valign="top">To file</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Positional 2</td>
</tr>
<tr>
<td valign="top">Qualifier 1: To 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="#CPYFRMPCD.FROMDOC"><b>FROMDOC</b></a></td>
<td valign="top">From document</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#CPYFRMPCD.TOMBR"><b>TOMBR</b></a></td>
<td valign="top">To member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b>, *FROMDOC</td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#CPYFRMPCD.MBROPT"><b>MBROPT</b></a></td>
<td valign="top">Replace or add records</td>
<td valign="top"><b><u>*REPLACE</u></b>, *ADD</td>
<td valign="top">Optional, Positional 5</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CPYFRMPCD.TRNTBL"><b>TRNTBL</b></a></td>
<td valign="top">Translate table</td>
<td valign="top">Single values: <b><u>*DFT</u></b>, *NONE<br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Translate table</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="#CPYFRMPCD.TRNFMT"><b>TRNFMT</b></a></td>
<td valign="top">Format of PC data</td>
<td valign="top"><b><u>*TEXT</u></b>, *NOTEXT</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CPYFRMPCD.TRNIGC"><b>TRNIGC</b></a></td>
<td valign="top">DBCS code page</td>
<td valign="top"><b><u>*DFT</u></b>, *JPN, *CHT, *BG5, *CHS, *KOR, *KSC, *SCGS, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CPYFRMPCD.IGCSOSI"><b>IGCSOSI</b></a></td>
<td valign="top">Insert DBCS SO/SI</td>
<td valign="top"><b><u>*YES</u></b>, *NO</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CPYFRMPCD.FROMFLR"></a>
<h3>From folder (FROMFLR)</h3>
<p>Specifies the name of a folder containing the PC document that is copied. This parameter can also specify the name of a folder path in the form:
</p>
<ul>
<li><u> folder1/folder2/folder3/.../foldern</u>
</li>
</ul>
<p>The path name can be up to 63 characters in length.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.TOFILE"></a>
<h3>To file (TOFILE)</h3>
<p>Specifies the name and library of the physical database file that you are copying the PC document to.
</p>
<p>If this file is a source file and you choose to translate the PC document, a sequence number is added and a system date of zeroes is added as it is copied to the file.
</p>
<p>This is a required parameter.
</p>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the database file.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the database file. If no current library entry exists in the library list, QGPL is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the library where the database file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.FROMDOC"></a>
<h3>From document (FROMDOC)</h3>
<p>Specifies the name of the PC document that is copied. The name has the following format:
</p>
<ul>
<li><u> filename.extension</u>
</li>
</ul>
<p>The filename can be from 1 to 8 characters, and the extension can be from 1 to 3 characters. The extension is not required.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.TOMBR"></a>
<h3>To member (TOMBR)</h3>
<p>Specifies the name of the member to contain the copied PC document. If no member is specified, the first member of the file is the member that is copied to. If the member does not exist, it is created.
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The PC document is copied to the first member.
</dd>
<dt><b>*FROMDOC</b></dt>
<dd>The member being copied to has the same name as the PC document. (The PC document name must be a valid system member name.)
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the member name that the PC document is copied to.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.MBROPT"></a>
<h3>Replace or add records (MBROPT)</h3>
<p>Specifies if the copied records are added to or replace the existing records in the physical file.
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The copied records replace the existing records in the physical file member.
</dd>
<dt><b>*ADD</b></dt>
<dd>The copied records are added to the existing records in the physical file member.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.TRNTBL"></a>
<h3>Translate table (TRNTBL)</h3>
<p>Specifies if translation is performed and, if so, the name of the translation table used to translate the data from ASCII to EBCDIC.
</p>
<p>
<b>Note: </b>For a user defined double-byte character set, this parameter also specifies if translation is performed and, if so, which translation table is used for single-byte translation.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>The default translation table is used.
</dd>
<dt><b><i>translation-table-name</i></b></dt>
<dd>Specify the name and library of the translation table.
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>The library list is used to locate the table.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the table. If no current library entry exists in the library list, QGPL is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the library where the table is located.
</dd>
</dl>
</dd>
<dt><b>*NONE</b></dt>
<dd>No translation from ASCII to EBCDIC is performed. Data is copied byte for byte.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.TRNFMT"></a>
<h3>Format of PC data (TRNFMT)</h3>
<p>Specifies the format of the records in the PC document.
</p>
<p>This parameter is not valid if *NONE is specified on the <b>Translate table</b> prompt (TRNTBL parameter).
</p>
<dl>
<dt><b><u>*TEXT</u></b></dt>
<dd>The PC document records in standard DOS ASCII variable length format are transformed to the fixed length format of the database file. The carriage return, line feed, and end of file characters are removed. Imbedded tab characters are expanded to blanks, and the record is padded with EBCDIC blanks to fill out the fixed length format.
</dd>
<dt><b>*NOTEXT</b></dt>
<dd>The records in the PC document are considered fixed length records of the same length as the physical database file records they are copied to.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.TRNIGC"></a>
<h3>DBCS code page (TRNIGC)</h3>
<p>Specifies the double-byte character set used for translation. Unless overridden by the <b>Translate table</b> prompt (TRNTBL parameter), this parameter also specifies the single-byte translation table.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>The default country or region's double-byte character set.
</dd>
<dt><b>*JPN</b></dt>
<dd>IBM Japanese.
</dd>
<dt><b>*CHT</b></dt>
<dd>IBM Traditional Chinese.
</dd>
<dt><b>*BG5</b></dt>
<dd>Taiwan Industry standard (BIG-5).
</dd>
<dt><b>*CHS</b></dt>
<dd>IBM Simplified Chinese.
</dd>
<dt><b>*KOR</b></dt>
<dd>IBM Korean (KS).
</dd>
<dt><b>*KSC</b></dt>
<dd>Korean Industry standard.
</dd>
<dt><b>*SCGS</b></dt>
<dd>The People's Republic of China National standard (GB).
</dd>
<dt><b>*NONE</b></dt>
<dd>No double-byte translation is performed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYFRMPCD.IGCSOSI"></a>
<h3>Insert DBCS SO/SI (IGCSOSI)</h3>
<p>Specifies if shift-out and shift-in characters are inserted during translation. This parameter is valid only for double-byte character set users. This parameter is not valid if *NONE is specified on the <b>Translate table</b> prompt (TRNTBL parameter).
</p>
<dl>
<dt><b><u>*YES</u></b></dt>
<dd>Shift-out and shift-in characters are inserted during translation.
</dd>
<dt><b>*NO</b></dt>
<dd>Shift-out and shift-in characters are not inserted during translation.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CPYFRMPCD.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CPYFRMPCD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>IWS1603</b></dt>
<dd>PC document copied to file with &amp;6 truncated records.
</dd>
<dt><b>IWS1611</b></dt>
<dd>PC document &amp;1 not copied.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYFRMPCD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>