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

185 lines
5.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>Retrieve Stop Word List Source (RTVSWLSRC)</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="RTVSWLSRC.Top_Of_Page"></a>
<h2>Retrieve Stop Word List Source (RTVSWLSRC)</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="#RTVSWLSRC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#RTVSWLSRC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#RTVSWLSRC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="RTVSWLSRC"></a>
<p>The Retrieve Stop Word List Source (RTVSWLSRC) command is used to retrieve the words from an IBM-supplied or user-created stop word list into a source file.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="RTVSWLSRC.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="#RTVSWLSRC.LANGID"><b>LANGID</b></a></td>
<td valign="top">Language ID</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="#RTVSWLSRC.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="#RTVSWLSRC.SRCMBR"><b>SRCMBR</b></a></td>
<td valign="top">Source member</td>
<td valign="top"><i>Name</i>, <b><u>*LANGID</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#RTVSWLSRC.TYPE"><b>TYPE</b></a></td>
<td valign="top">Stop word list type</td>
<td valign="top"><b><u>*IBM</u></b>, *USER</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="RTVSWLSRC.LANGID"></a>
<h3>Language ID (LANGID)</h3>
<p>Specifies the language identifier (ID) for the stop word list.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVSWLSRC.SRCFILE"></a>
<h3>Source file (SRCFILE)</h3>
<p>Specifies the qualified name of the source file used to receive the stop word list words. The contents of the source file are replaced.
</p>
<dl>
<dt><b><i>source-file-name</i></b></dt>
<dd>Specify the name of the source file.
</dd>
</dl>
<p>The possible library values are:
</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 job is used to locate the source file. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the source file is located.
</dd>
</dl>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVSWLSRC.SRCMBR"></a>
<h3>Source member (SRCMBR)</h3>
<p>Specifies the name of the source file member used to receive the stop word list words. The member is in the source file specified on the SRCFILE parameter.
</p>
<dl>
<dt><b><u>*LANGID</u></b></dt>
<dd>The language ID is used as the source file member name.
</dd>
<dt><b><i>source-file-member-name</i></b></dt>
<dd>Specify the name of the member in the source file used to receive the stop word list.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="RTVSWLSRC.TYPE"></a>
<h3>Stop word list type (TYPE)</h3>
<p>Specifies the type of stop word list being retrieved
</p>
<dl>
<dt><b><u>*IBM</u></b></dt>
<dd>The stop word list is IBM-supplied.
</dd>
<dt><b>*USER</b></dt>
<dd>The stop word list is user-created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVSWLSRC.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
RTVSWLSRC LANGID(ENG) SRCFILE(MYLIB/MYFILE)
</pre>
</p>
<p>This command retrieves the stop word list into source file MYFILE in library MYLIB that has the language ID ENG.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="RTVSWLSRC.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF8723</b></dt>
<dd>Record length too small for database source file.
</dd>
<dt><b>CPF8725</b></dt>
<dd>&amp;1 type stop word list not supported for language.
</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="#RTVSWLSRC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>