ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/obj4a.htm

93 lines
3.1 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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>Using User Index APIs</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<a name="Top_Of_Page"></a>
<h2>Using User Index APIs</h2>
<p>A <strong>user index</strong> is an object that allows search functions for
data in the index and automatically sorts data based on the value of the data.
User indexes are permanent objects in the user domain or in the system domain.
They have an object type of *USRIDX and a maximum size of
1 terabyte (1&nbsp;099&nbsp;511&nbsp;627&nbsp;776 bytes).
They help streamline table searching,
cross-referencing, and ordering of data. In general, if your table is longer
than 1000 entries, an index performs faster than a user-sorted table.</p>
<p>You can use user indexes to:</p>
<ul>
<li>Provide search functions</li>
<li>Do faster insert operations than in a database file</li>
<li>Do faster retrieve operations than in a database file</li>
<li>Create an index by name, such as a telephone directory</li>
<li>Use order entry programs</li>
<li>Look up abbreviations in an index</li>
<li>Sort data automatically based on the hexadecimal value of a key</li>
</ul>
<p>User index
entries cannot contain a pointer. You can save and restore all the data
in an index. You can also save and restore user indexes to another system.
For more information about user index considerations, refer to the
<a href="../apiref/conIndexCons.htm" target="_blank">User index considerations</a>
in API concepts.
</p>
<p> In addition to the user index APIs, you can work with user indexes through
the following:</p>
<ul>
<li>ILE C programming language</li>
<li>Machine interface (MI) instructions</li>
<li>Delete User Index (DLTUSRIDX) command</li>
</ul>
<p>For details about MI instructions, refer to the
<a href="../rzatk/mitoc.htm">iSeries
Machine Interface Instructions</a>, which provides detailed descriptions of the
iSeries<SUP>(TM)</SUP> machine interface instruction fields and the formats of those fields.
For details about the DLTUSRIDX command,
see the <a href="../rbam6/rbam6clmain.htm">Control Language (CL)</a> topic.</p>
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="obj1.htm">Object APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>