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

353 lines
12 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!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 To PC Document (CPYTOPCD)</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="CPYTOPCD.Top_Of_Page"></a>
<h2>Copy To PC Document (CPYTOPCD)</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="#CPYTOPCD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CPYTOPCD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CPYTOPCD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CPYTOPCD"></a>
<p>The Copy To PC Document (CPYTOPCD) command copies a member from a system database file to a PC document in a folder.
</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 CPYTOPCD</h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>IWS1612</b></dt>
<dd>Member &amp;1 not copied to PC document.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CPYTOPCD.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="#CPYTOPCD.FROMFILE"><b>FROMFILE</b></a></td>
<td valign="top">From 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: From 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="#CPYTOPCD.TOFLR"><b>TOFLR</b></a></td>
<td valign="top">To folder</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#CPYTOPCD.FROMMBR"><b>FROMMBR</b></a></td>
<td valign="top">From member</td>
<td valign="top"><i>Name</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
<tr>
<td valign="top"><a href="#CPYTOPCD.TODOC"><b>TODOC</b></a></td>
<td valign="top">To document</td>
<td valign="top"><i>Character value</i>, <b><u>*FROMMBR</u></b></td>
<td valign="top">Optional, Positional 4</td>
</tr>
<tr>
<td valign="top"><a href="#CPYTOPCD.REPLACE"><b>REPLACE</b></a></td>
<td valign="top">Replace document</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional, Positional 5</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CPYTOPCD.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="#CPYTOPCD.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="#CPYTOPCD.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="#CPYTOPCD.RCDFMT"><b>RCDFMT</b></a></td>
<td valign="top">Record format</td>
<td valign="top"><i>Name</i>, <b><u>*ALL</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CPYTOPCD.FROMFILE"></a>
<h3>From file (FROMFILE)</h3>
<p>Specifies the name and library of the database file you are copying data from. The file can be either a physical file or a logical 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>
<p>If this file is a source file and the records are being translated from EBCDIC to ASCII, the line number and date are removed when the records are written in the PC document.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.TOFLR"></a>
<h3>To folder (TOFLR)</h3>
<p>Specifies the name of the folder that contains the PC document being copied to.
</p>
<p>The name can be a fully qualified path name of 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. All folders in the path must exist.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.FROMMBR"></a>
<h3>From member (FROMMBR)</h3>
<p>Specifies the name of the member that is copied.
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The first member of the file is copied.
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the member that is copied.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.TODOC"></a>
<h3>To document (TODOC)</h3>
<p>Specifies the name of the PC document in the folder to contain the copied database file member. If the document does not exist, it is created.
</p>
<dl>
<dt><b><u>*FROMMBR</u></b></dt>
<dd>The name of the PC document is the same as the member name.
</dd>
<dt><b><i>document-name</i></b></dt>
<dd>Specify a valid document name which has the form:
<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.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.REPLACE"></a>
<h3>Replace document (REPLACE)</h3>
<p>Specifies if an existing document is replaced by the copy operation.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>If a document of this name already exists in the folder specified by the <b>To folder</b> prompt (TOFLR parameter), the copy is not performed.
</dd>
<dt><b>*YES</b></dt>
<dd>If a document of this name already exists in the folder specified by the <b>To folder</b> prompt (TOFLR parameter), it is replaced by the database file member that is copied.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.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 EBCDIC to ASCII.
</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>
<p>The format of the records in the PC document is handled by the <b>Format of PC data</b> prompt (TRNFMT parameter),
</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 EBCDIC to ASCII is performed. The records are copied to the PC document as fixed-length records. There are no ASCII carriage return, line feed, or end of file characters added to the PC document. The length of these fixed length records is the same as the length of the records in the database file member.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.TRNFMT"></a>
<h3>Format of PC data (TRNFMT)</h3>
<p>Specifies the format the records in the PC document are to have.
</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 records in the PC document will be written in standard DOS ASCII variable length format. The ASCII carriage return and line feed characters are added to the end of each record, and the ASCII end of file character is added to the end of the PC document.
</dd>
<dt><b>*NOTEXT</b></dt>
<dd>The records in the PC document will be fixed length records. The length of the records in the database file is used for the length of the records in the PC document.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.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="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CPYTOPCD.RCDFMT"></a>
<h3>Record format (RCDFMT)</h3>
<p>Specifies the record format(s) of records to be copied. The possible values are:
</p>
<dl>
<dt><b><u>*ALL</u></b></dt>
<dd>All records (of all record formats) in the database file are to be copied.
</dd>
<dt><b><i>record-format-name</i></b></dt>
<dd>Specify the name of a record format if you want only records with that specific record format to be copied.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CPYTOPCD.COMMAND.EXAMPLES">Examples</a></h3>None
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CPYTOPCD.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>IWS1612</b></dt>
<dd>Member &amp;1 not copied to PC document.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CPYTOPCD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>