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

183 lines
6.2 KiB
HTML
Raw 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>Work with Search Indexes (WRKSCHIDX)</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="WRKSCHIDX.Top_Of_Page"></a>
<h2>Work with Search Indexes (WRKSCHIDX)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>Interactive environments (*INTERACT *IPGM *IREXX *EXEC)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#WRKSCHIDX.PARAMETERS.TABLE">Parameters</a><br>
<a href="#WRKSCHIDX.COMMAND.EXAMPLES">Examples</a><br>
<a href="#WRKSCHIDX.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="WRKSCHIDX"></a>
<p>The Work with Search Indexes (WRKSCHIDX) command allows you to show a list of search indexes from one or more libraries.
</p>
<p><b>Restriction:</b>
</p>
<ul>
<li>Only the libraries to which you have use (*USE) authority will be searched.
</li>
<li>Only the search indexes forms to which you have some authority will be shown on the display.
</li>
<li>To work with search index entries, you must have *USE authority to the Work with Search Index Entries (WRKSCHIDXE) command, and change (*CHANGE) authority for the search index.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKSCHIDX.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="WRKSCHIDX.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="#WRKSCHIDX.SCHIDX"><b>SCHIDX</b></a></td>
<td valign="top">Search index</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: Search index</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, *ALLUSR, *ALL</td>
</tr></table>
<table width="100%">
<tr><td align="right"><a href="#WRKSCHIDX.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="WRKSCHIDX.SCHIDX"></a>
<h3>Search index (SCHIDX)</h3>
<p>Specifies the search indexes to be shown.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Search index</b>
</p>
<dl>
<dt><b>*ALL</b></dt>
<dd>All search indexes are shown.
</dd>
<dt><b><i>generic-name</i></b></dt>
<dd>Specify the generic name of the search indexes to be shown. A generic name is a character string that contains one or more characters followed by an asterisk (*). If a generic name is specified, all search indexes that have names with the same prefix as the generic name are shown.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the search index to be shown.
</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. All objects in these libraries with the specified object name are shown.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the thread is searched. If no library is specified as the current library for the thread, the QGPL library is searched.
</dd>
</dl>
<dl>
<dt><b>*USRLIBL</b></dt>
<dd>If a current library entry exists in the library list for the current thread, the current library and the libraries in the user portion of the library list are searched. If there is no current library entry, only the libraries in the user portion of the library list are searched.
</dd>
</dl>
<dl>
<dt><b>*ALLUSR</b></dt>
<dd>All user libraries are searched. All libraries with names that do not begin with the letter Q are searched except for the following:
<p>
<pre>
#CGULIB #DSULIB #SEULIB
#COBLIB #RPGLIB
#DFULIB #SDALIB
</pre>
</p>
<p>Although the following Qxxx libraries are provided by IBM, they typically contain user data that changes frequently. Therefore, these libraries are considered user libraries and are also searched:
</p>
<p>
<pre>
QDSNX QRCLxxxxx QUSRIJS QUSRVxRxMx
QGPL QSRVAGT QUSRINFSKR
QGPL38 QSYS2 QUSRNOTES
QMGTC QSYS2xxxxx QUSROND
QMGTC2 QS36F QUSRPOSGS
QMPGDATA QUSER38 QUSRPOSSA
QMQMDATA QUSRADSM QUSRPYMSVR
QMQMPROC QUSRBRM QUSRRDARS
QPFRDATA QUSRDIRCL QUSRSYS
QRCL QUSRDIRDB QUSRVI
</pre>
</p>
<ol>
<li>'xxxxx' is the number of a primary auxiliary storage pool (ASP).
</li>
<li>A different library name, in the format QUSRVxRxMx, can be created by the user for each previous release supported by IBM to contain any user commands to be compiled in a CL program for the previous release. For the QUSRVxRxMx user library, VxRxMx is the version, release, and modification level of a previous release that IBM continues to support.
</li>
</ol>
</dd>
</dl>
<dl>
<dt><b>*ALL</b></dt>
<dd>All libraries in the system, including QSYS, are searched.
</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="#WRKSCHIDX.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKSCHIDX.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
WRKSCHIDX SCHIDX(*ALL)
</pre>
</p>
<p>This command displays the Work with Search Indexes panel, showing a list of all the search indexes in the library list.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKSCHIDX.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="WRKSCHIDX.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF9809</b></dt>
<dd>Library &amp;1 cannot be accessed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#WRKSCHIDX.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>