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

334 lines
14 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 Binder Source (RTVBNDSRC)</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="RTVBNDSRC.Top_Of_Page"></a>
<h2>Retrieve Binder Source (RTVBNDSRC)</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="#RTVBNDSRC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RTVBNDSRC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RTVBNDSRC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RTVBNDSRC"></a>
<p>The Retrieve Binder Source (RTVBNDSRC) command can be used to retrieve the exports from a set of modules, a service program, or both, and place them (along with the binder language statements needed for the exports) in a specified file member. This file member can later be used as input to the Create Service Program (CRTSRVPGM) command SRCMBR parameter. After the binder language has been retrieved into a source file member, you can edit the binder language to make changes as needed.
</p>
<p>By default, the CRTSRVPGM command has a binder language file specified on the EXPORT and SRCFILE parameters to identify the exports from the service program. The RTVBNDSRC command can be useful in helping you automatically create this binder language.
</p>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have use (*USE) authority to the Create Source Physical File (CRTSRCPF) command, if the file does not exist.
</li>
<li>You must have *USE authority to the Reorganize Physical File Member (RGZPFM) command.
</li>
<li>You must have *USE authority to the Add Physical File Member (ADDPFM) command, if the member does not exist.
</li>
<li>You must have *USE authority to the modules or service program from which the exports are being retrieved.
</li>
<li>You must have execute (*EXECUTE) authority to the libraries in which the modules or service program exist.
</li>
<li>If the source file and member to receive the binder language exist, you must have change (*CHANGE) authority and either object alter (*OBJALTER) or object management (*OBJMGT) authority to the file, and *EXECUTE authority to the library that contains the file.
</li>
<li>If the source file exists but the source member needs to be created, you must have *CHANGE authority and either *OBJALTER or *OBJMGT authority to the file, and *EXECUTE, read (*READ) and add (*ADD) authorities to the library that contains the file.
</li>
<li>If the source file and member need to be created, you must have *EXECUTE, *READ and *ADD authorities to the library.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RTVBNDSRC.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="#RTVBNDSRC.MODULE"><b>MODULE</b></a></td>
<td valign="top">Module</td>
<td valign="top">Values (up to 300 repetitions): <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Module</td>
<td valign="top"><i>Generic name, name</i>, *ALL</td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB, *USRLIBL</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#RTVBNDSRC.SRVPGM"><b>SRVPGM</b></a></td>
<td valign="top">Service program</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Service 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="#RTVBNDSRC.SRCFILE"><b>SRCFILE</b></a></td>
<td valign="top">Export source file</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Export source file</td>
<td valign="top"><i>Name</i>, <b><u>QSRVSRC</u></b></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="#RTVBNDSRC.SRCMBR"><b>SRCMBR</b></a></td>
<td valign="top">Export source member</td>
<td valign="top"><i>Name</i>, <b><u>*DFT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVBNDSRC.MBROPT"><b>MBROPT</b></a></td>
<td valign="top">Replace or add records</td>
<td valign="top">*ADD, <b><u>*REPLACE</u></b></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RTVBNDSRC.MODULE"></a>
<h3>Module (MODULE)</h3>
<p>Specifies the list of modules from which to retrieve the exported symbols. If duplicate module and library specifications are found, only the first instance of the duplicate module and library is used.
</p>
<p>At least one value must be specified for this parameter or the <b>Service program (SRVPGM)</b> parameter.
</p>
<p>You can specify up to 300 values for this parameter.
</p>
<p><b>Qualifier 1: Module</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>The exported symbols from all of the modules in the specified library are retrieved.
</dd>
<dt><b><i>generic-name</i></b></dt>
<dd>Specify a generic module name from which to retrieve the exported symbols. All modules that have names with the same prefix in the specified library or libraries are used. A generic name is a character string of one or more characters followed by an asterisk (*); for example, ABC*. The asterisk substitutes for any valid characters. A generic name specifies all objects with names that begin with the generic prefix for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete object name.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the module from which to retrieve the exported symbols.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b>*USRLIBL</b></dt>
<dd>Only the libraries in the user portion of the job's library list are searched.
</dd>
<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="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVBNDSRC.SRVPGM"></a>
<h3>Service program (SRVPGM)</h3>
<p>Specifies the service program from which to retrieve the exported symbols. At least one value must be specified for this parameter or the <b>Module (MODULE)</b> parameter.
</p>
<p><b>Qualifier 1: Service program</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the service program from which to retrieve the exported symbols.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the job's library list are searched until the first match is found.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<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="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVBNDSRC.SRCFILE"></a>
<h3>Export source file (SRCFILE)</h3>
<p>Specifies the source file that is to hold the binder language for the exported symbols. If the source file does not exist, it is created.
</p>
<p><b>Notes:</b>
</p>
<ul>
<li>Only a database physical file of type *SRC can be specified. Distributed data management (DDM) files are not supported.
</li>
<li>If the source file to receive the binder language exists, its record length must be a minimum of 92 bytes.
</li>
</ul>
<p><b>Qualifier 1: Export source file</b>
</p>
<dl>
<dt><b><u>QSRVSRC</u></b></dt>
<dd>The source file name is QSRVSRC.
</dd>
<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 job's library list are searched until the first match is found. If a source file by the name specified is not found in the library list, it is created in the current library. If there is no current library, the QGPL library is used.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is searched. If a source file by the name specified does not exist, it is created in the current library. If there is no current library, the QGPL library is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the library to be searched. If a source file by the name specified is not found in this library, the source file is created in this library.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVBNDSRC.SRCMBR"></a>
<h3>Export source member (SRCMBR)</h3>
<p>Specifies the member in the source file that is to hold the binder language for the exported symbols. Only one source member will contain the binder language.
</p>
<p>If the member does not exist in the source file specified, the member is created.
</p>
<dl>
<dt><b><u>*DFT</u></b></dt>
<dd>The name of the source file member is taken from the value specified for the <b>Service program (SRVPGM)</b> parameter, if a service program is specified. Otherwise, the name of the source file member is taken from the value specified for the <b>:Module (MODULE)</b> parameter,
<ul>
<li>If only one module is specified, the name of that module is the member name used.
</li>
<li>If more than one module is specified, the name of the first module specified is used.
</li>
<li>If the value *ALL or a generic name is specified, the module name of the first occurrence found is the source member name used.
</li>
</ul>
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the member that will contain the generated source binder language.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVBNDSRC.MBROPT"></a>
<h3>Replace or add records (MBROPT)</h3>
<p>Specifies whether the generated binder language statements are replaced or added to the existing statements.
</p>
<dl>
<dt><b><u>*REPLACE</u></b></dt>
<dd>The system clears the existing member and adds the new records.
</dd>
<dt><b>*ADD</b></dt>
<dd>The system adds the new records to the end of the existing records.
<p>
<b>Note: </b>If the member already exists and, for example, already contains STRPGMEXP and ENDPGMEXP statements, the member may contain multiple STRPGMEXP and ENDPGMEXP statements in the binder language at the end of this operation. You must edit these multiple statements in order to use the binder language with the Create Service Program (CRTSRVPGM) command.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVBNDSRC.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
RTVBNDSRC MODULE(MYLIB/*ALL)
SRCFILE(MYLIB/MYBINDFILE) MBROPT(*ADD)
</pre>
</p>
<p>This command retrieves the exports from all modules in the library MYLIB, and places them in the source member with the name of the first module found. If this source member does not exist in the file MYBINDFILE in the library MYLIB, it is created. The export statements are added to the end of the member. If multiple start and end program export statements exist in the file when this command is ended, the source member must be edited before it is used to create a service program. Either the extra STRPGMEXP, ENDPGMEXP statements can be removed, or the PGMLVL parameter can be added to the STRPGMEXP statements, if some of the export blocks are for previous versions of the service program.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVBNDSRC.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF5CA5</b></dt>
<dd>Record length too small for data base source file.
</dd>
<dt><b>CPF5D06</b></dt>
<dd>Not authorized to library &amp;2, or file &amp;1 in library &amp;2, or member &amp;3.
</dd>
<dt><b>CPF5D08</b></dt>
<dd>File &amp;1 in library &amp;2 not supported file type.
</dd>
<dt><b>CPF9801</b></dt>
<dd>Object &amp;2 in library &amp;3 not found.
</dd>
<dt><b>CPF9802</b></dt>
<dd>Not authorized to object &amp;2 in &amp;3.
</dd>
<dt><b>CPF9803</b></dt>
<dd>Cannot allocate object &amp;2 in library &amp;3.
</dd>
<dt><b>CPF9810</b></dt>
<dd>Library &amp;1 not found.
</dd>
<dt><b>CPF9820</b></dt>
<dd>Not authorized to use library &amp;1.
</dd>
<dt><b>CPF9832</b></dt>
<dd>Function not supported for DDM file &amp;2.
</dd>
<dt><b>CPF9834</b></dt>
<dd>Input file &amp;1 in library &amp;2 is not a source file.
</dd>
<dt><b>CPF9848</b></dt>
<dd>Cannot open file &amp;1 in library &amp;2 member &amp;3.
</dd>
<dt><b>CPF9899</b></dt>
<dd>Error occurred during processing of command.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVBNDSRC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>