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

255 lines
7.9 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>Retrieve CL Source (RTVCLSRC)</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="RTVCLSRC.Top_Of_Page"></a>
<h2>Retrieve CL Source (RTVCLSRC)</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="#RTVCLSRC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RTVCLSRC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RTVCLSRC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RTVCLSRC"></a>
<p>The Retrieve CL Source (RTVCLSRC) command is used to retrieve the source statements from an OPM CL program that was used to compile that program. These source statements are placed into a source file member, which can be used as input when recompiling the CL program.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVCLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RTVCLSRC.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="#RTVCLSRC.PGM"><b>PGM</b></a></td>
<td valign="top">Program</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: Program</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" rowspan="3"><a href="#RTVCLSRC.SRCFILE"><b>SRCFILE</b></a></td>
<td valign="top">Source 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: Source 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="#RTVCLSRC.SRCMBR"><b>SRCMBR</b></a></td>
<td valign="top">Source member</td>
<td valign="top"><i>Name</i>, <b><u>*PGM</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RTVCLSRC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RTVCLSRC.PGM"></a>
<h3>Program (PGM)</h3>
<p>Specifies the OPM CL program whose source is to be retrieved.
</p>
<p>
<b>Note: </b>RTVCLSRC cannot be used to retrieve the source for ILE CL programs and modules.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Program</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the program.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is used to locate the program. If no library is specified as the current library for the thread, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library where the program is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVCLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVCLSRC.SRCFILE"></a>
<h3>Source file (SRCFILE)</h3>
<p>Specifies the database source file into which the CL source statements are to be written. This file must exist when the command is run.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Source file</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the source file.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is used to locate the source file. If no library is specified as the current library for the thread, the QGPL library is used.
</dd>
</dl>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVCLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVCLSRC.SRCMBR"></a>
<h3>Source member (SRCMBR)</h3>
<p>Specifies the database source file member into which the CL source statements are to be written. If the name is not specified, the CL program name is used. If the member existed before the command was run, it is cleared before any source statements are written into it. If the member did not exist, it is created.
</p>
<dl>
<dt><b><u>*PGM</u></b></dt>
<dd>The name of the CL program is used as the member name.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the source file member that will contain the CL source statements.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVCLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVCLSRC.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
RTVCLSRC PGM(JOHN1/TEXT1) SRCFILE(JOHN2) SRCMBR(JOHN3)
</pre>
</p>
<p>This command retrieves the source statements from the CL program named TEXT1 in library JOHN1. The retrieved source statements are placed into the file named JOHN2, and are named as member JOHN3.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVCLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVCLSRC.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF0560</b></dt>
<dd>Program &amp;1 in &amp;2 not a CL program.
</dd>
<dt><b>CPF0561</b></dt>
<dd>Unable to retrieve CL source from CL program &amp;2.
</dd>
<dt><b>CPF0562</b></dt>
<dd>File &amp;1 in &amp;2 not a data base source file.
</dd>
<dt><b>CPF0563</b></dt>
<dd>Record length too small for data base source file.
</dd>
<dt><b>CPF0564</b></dt>
<dd>Unable to add data base member &amp;3 to file.
</dd>
<dt><b>CPF0565</b></dt>
<dd>Source from CL program &amp;4 not retrieved.
</dd>
<dt><b>CPF0566</b></dt>
<dd>Source not available for CL program &amp;1 in &amp;2.
</dd>
<dt><b>CPF9801</b></dt>
<dd>Object &amp;2 in library &amp;3 not found.
</dd>
<dt><b>CPF9803</b></dt>
<dd>Cannot allocate object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9805</b></dt>
<dd>Object &amp;2 in library &amp;3 destroyed.
</dd>
<dt><b>CPF9806</b></dt>
<dd>Cannot perform function for object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9807</b></dt>
<dd>One or more libraries in library list deleted.
</dd>
<dt><b>CPF9808</b></dt>
<dd>Cannot allocate one or more libraries on library list.
</dd>
<dt><b>CPF9809</b></dt>
<dd>Library &amp;1 cannot be accessed.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9811</b></dt>
<dd>Program &amp;1 in library &amp;2 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
<dt><b>CPF9821</b></dt>
<dd>Not authorized to program &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9822</b></dt>
<dd>Not authorized to file &amp;1 in library &amp;2.
</dd>
<dt><b>CPF9830</b></dt>
<dd>Cannot assign library &amp;1.
</dd>
<dt><b>CPF9848</b></dt>
<dd>Cannot open file &amp;1 in library &amp;2 member &amp;3.
</dd>
<dt><b>CPF9849</b></dt>
<dd>Error while processing file &amp;1 in library &amp;2 member &amp;3.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVCLSRC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>