ibm-information-center/dist/eclipse/plugins/i5OS.ic.apifinder_5.4.0.1/finder.htm

351 lines
13 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">
<!-- 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. -->
<title>API finder</title>
<link rel="stylesheet" type="text/css" href="finder.css" >
<link rel="stylesheet" type="text/css" href="ic.css" >
<script language="Javascript" type="text/javascript">
var alert_string_1 = "Select an API category and press Go.";
var alert_string_2 = "Enter a search term and press Go.";
//START NON-TRANSLATABLE
var lang;
var param_array = window.location.search.split("lang=")[1];
if (param_array.length > 1)
{
var p_array = param_array.split("&");
lang = p_array[0];
// alert("lang="+lang);
}
else
lang = "en";
function openLink(url)
{
var url_low = url.toLowerCase();
var topic_string = "/help/topic/apis/";
if (url_low.indexOf("http://") == 0 ||
url_low.indexOf("https://") == 0 ||
url_low.indexOf("file://") == 0 ||
url_low.indexOf("ftp://") == 0 )
{
window.open(url, 'pdf_window');
}
else if ( url_low.lastIndexOf('.pdf') == url.length-4)
{
window.open(topic_string+url, 'pdf_window');
}
else
{
window.location.replace(topic_string+url);
}
}
function goCategory() {
var catpage = "back1.htm";
catpage = document.category.catfind.value;
openLink(catpage);
}
function goSearch() {
document.form_1.query.value = document.form_1.query_entry.value;
document.form_1.lang.value = lang;
document.form_1.table_name.value = "table";
document.form_1.query_filter.value = "";
document.form_1.sort_column.value = "apidescriptivename";
document.form_1.sort_type.value = "ascending";
document.form_1.field.value = "_all";
if (document.form_1.search_type_1[0].checked)
document.form_1.search_type.value = "and";
else
document.form_1.search_type.value = "or";
var query = document.form_1.query.value;
if (document.form_1.query_entry.value == null || document.form_1.query_entry.value == "") {
alert(alert_string_2);
} else {
//Default query is for all fields. Construct query filter to thin results to apidescriptivename and apiname fields
//Split up search string by spaces
document.form_1.query_filter.value = ""; //reset field to empty
var inputString = "";
inputString = document.form_1.query_entry.value.split(" ");
for (var a=0; a < inputString.length; a++) {
//Strip out bad characters
inputString[a] = removeBadChars(inputString[a]);
//alert(inputString[a]);
if (document.form_1.search_type_1[0].checked) { //and search
document.form_1.query_filter.value += " AND ";
document.form_1.query_filter.value += "(apidescriptivename:z*" + inputString[a] + "* OR apiname:z*" + inputString[a] + "*)";
} else { //or search
if (a != 0) //not first value
document.form_1.query_filter.value += " ";
else
document.form_1.query_filter.value += " AND (";
document.form_1.query_filter.value += "apidescriptivename:z*" + inputString[a] + "* apiname:z*" + inputString[a] + "*";
}
}
if (document.form_1.search_type_1[1].checked) { //or search
document.form_1.query_filter.value += ")";
}
document.form_1.submit();
}
return false;
}
function enterCheck() {
if (document.form_1.query_entry.value == null || document.form_1.query_entry.value == "") {
alert(alert_string_2);
} else {
goSearch();
}
}
function removeBadChars(s) {
var bag = "*~!@#$%^&()_-+=[]{}|:;<>,.?/ \b\t\n\f\r\"\'\\";
var i;
var returnString = "";
// Search through string's characters one by one.
// If character is not in bag, append to returnString.
for (i = 0; i < s.length; i++)
{
// Check that current character isn't whitespace.
var c = s.charAt(i);
if (bag.indexOf(c) == -1) returnString += c;
}
return returnString;
}
function goAlpha()
{
if (document.form_2.showall[0].checked)
{
document.form_1.lang.value = lang;
document.form_1.query.value = "a";
document.form_1.table_name.value = "list_1";
document.form_1.query_filter.value = "";
document.form_1.search_type.value = "keyword";
document.form_1.sort_column.value = "apidescriptivename";
document.form_1.sort_type.value = "ascending";
document.form_1.field.value = "apidescriptivename";
document.form_1.submit();
}
else if (document.form_2.showall[1].checked)
{
document.form_1.lang.value = lang;
document.form_1.query.value = "a";
document.form_1.table_name.value = "list_2";
document.form_1.query_filter.value = "";
document.form_1.search_type.value = "keyword";
document.form_1.sort_column.value = "apiname";
document.form_1.sort_type.value = "ascending";
document.form_1.field.value = "apiname";
document.form_1.submit();
}
else if (document.form_2.showall[2].checked)
{
document.form_1.lang.value = lang;
document.form_1.query.value = "new";
document.form_1.table_name.value = "table";
document.form_1.query_filter.value = "";
document.form_1.search_type.value = "and";
document.form_1.sort_column.value = "apidescriptivename";
document.form_1.sort_type.value = "ascending";
document.form_1.field.value = "changestatus";
document.form_1.submit();
}
else if (document.form_2.showall[3].checked)
{
document.form_1.lang.value = lang;
document.form_1.query.value = "updated";
document.form_1.table_name.value = "table";
document.form_1.query_filter.value = "";
document.form_1.search_type.value = "and";
document.form_1.sort_column.value = "apidescriptivename";
document.form_1.sort_type.value = "ascending";
document.form_1.field.value = "changestatus";
document.form_1.submit();
}
else if (document.form_2.showall[4].checked)
{
document.form_1.lang.value = lang;
document.form_1.query.value = "exitprogram";
document.form_1.table_name.value = "table";
document.form_1.query_filter.value = "";
document.form_1.search_type.value = "and";
document.form_1.sort_column.value = "apidescriptivename";
document.form_1.sort_type.value = "ascending";
document.form_1.field.value = "specialapi";
document.form_1.submit();
}
}
//END NON-TRANSLATABLE
</script>
</head>
<body>
<H2>API finder</H2>
<NOSCRIPT><p><strong>Important:</strong> This finder uses Javascript, but Javascript is either not available or enabled in your browser.
If you do not have access to a browser that supports Javascript,
you can still view API information through the <a href="aplist.htm">category listings</a>.
</p>
</NOSCRIPT>
<P>Use the API finder to find information about iSeries<sup>(TM)</sup> APIs.
(See <a href="#note">note</a>.)
You find APIs by category or by name.</P>
<FORM NAME="category">
<table cellspacing="4" cellpadding="4" border="0" WIDTH="85%" ALIGN="CENTER">
<tr>
<td colspan="2" class="finderbar"><font size="+1"><STRONG>Find by category</strong></font></td>
</tr>
<tr>
<td colspan="2"><label for="catfind">Select a category of APIs.</label></td>
</tr>
<tr>
<td width="15%"><BR><BR></td>
<td>
<SELECT NAME="catfind" SIZE="1" id="catfind">
<OPTION VALUE="blank"></OPTION>
<OPTION VALUE="back1.htm">Backup and Recovery</OPTION>
<OPTION VALUE="cms.htm">Client Management Support</OPTION>
<OPTION VALUE="clust1.htm">Cluster</OPTION>
<OPTION VALUE="comm.htm">Communications</OPTION>
<OPTION VALUE="config.htm">Configuration</OPTION>
<OPTION VALUE="catcrypt.htm">Cryptographic Services</OPTION>
<OPTION VALUE="file1.htm">Database and File</OPTION>
<OPTION VALUE="catdate.htm">Date and Time</OPTION>
<OPTION VALUE="debug1.htm">Debugger</OPTION>
<OPTION VALUE="domino.htm">Domino<SUP>(TM)</SUP></OPTION>
<OPTION VALUE="dsm.htm">Dynamic Screen Manager</OPTION>
<OPTION VALUE="edit1.htm">Edit Function</OPTION>
<OPTION VALUE="catgddm.htm">GDDM<SUP>(R)</SUP></OPTION>
<OPTION VALUE="hfs1.htm">Hierarchical File System</OPTION>
<OPTION VALUE="hll.htm">High-Level Language</OPTION>
<OPTION VALUE="../rzaie/rzaierefapi.htm">HTTP Server</OPTION>
<OPTION VALUE="ile1a1.htm">ILE CEE</OPTION>
<OPTION VALUE="icu.htm">International Components for Unicode (ICU)</OPTION>
<OPTION VALUE="catisacc.htm">iSeries<SUP>(TM)</SUP> Access for Windows<SUP>(R)</SUP></OPTION>
<OPTION VALUE="catjava.htm">Java<SUP>(TM)</SUP></OPTION>
<OPTION VALUE="jc1.htm">Journal and Commit</OPTION>
<OPTION VALUE="catmi.htm">Machine Interface Instructions</OPTION>
<OPTION VALUE="mh1.htm">Message Handling</OPTION>
<OPTION VALUE="misc1.htm">Miscellaneous</OPTION>
<OPTION VALUE="1ls1.htm">National Language Support</OPTION>
<OPTION VALUE="netmg.htm">Network Management</OPTION>
<OPTION VALUE="obj1.htm">Object</OPTION>
<OPTION VALUE="off1a.htm">Office</OPTION>
<OPTION VALUE="oa1.htm">Operational Assistant</OPTION>
<OPTION VALUE="pase1.htm">i5/OS<SUP>(R)</SUP> PASE</OPTION>
<OPTION VALUE="perfmgmt.htm">Performance Management</OPTION>
<OPTION VALUE="print1.htm">Print</OPTION>
<OPTION VALUE="pm1.htm">Problem Management</OPTION>
<OPTION VALUE="misc1b.htm">Process Open List</OPTION>
<OPTION VALUE="pgm1.htm">Program and CL command</OPTION>
<OPTION VALUE="rzah4mst.htm">Pthread</OPTION>
<OPTION VALUE="reg1.htm">Registration Facility</OPTION>
<OPTION VALUE="catrcp.htm">Remote Control Panel</OPTION>
<OPTION VALUE="rpc.htm">Remote Procedure Call</OPTION>
<OPTION VALUE="sec.htm">Security</OPTION>
<OPTION VALUE="ss1.htm">Server Support</OPTION>
<OPTION VALUE="sm1.htm">System Manager</OPTION>
<OPTION VALUE="sw1.htm">Software Product</OPTION>
<OPTION VALUE="unix.htm">UNIX<SUP>(R)</SUP>-Type</OPTION>
<OPTION VALUE="uim1.htm">User Interface Manager</OPTION>
<OPTION VALUE="vt1a.htm">Virtual Terminal</OPTION>
<OPTION VALUE="wm1.htm">Work Management</OPTION>
<OPTION VALUE="wss1.htm">Work Station Support</OPTION>
<OPTION VALUE="../rzakl/rzaklreferenct.htm">XML Parsing</OPTION>
</SELECT>
<INPUT TYPE="button" NAME="Go" VALUE="Go" onclick="goCategory()">
</td>
</tr>
</table>
</FORM>
<br>
<FORM NAME="form_1" method="GET" ACTION="InteractiveTableManager" onSubmit="return goSearch()">
<table cellspacing="4" cellpadding="4" border="0" WIDTH="85%" ALIGN="CENTER">
<TR>
<TD colspan="2" class="finderbar"><font size="+1"><STRONG>Find by name</strong></font></TD>
</TR>
<TR>
<TD colspan="2"><label for="searchwords">Find by API descriptive name, by API name, or by part of the name.</label></TD>
</TR>
<TR>
<TD width="15%"><BR><BR></TD>
<TD><font size="-1">Example: Enter <EM>QEZCHBKS</EM>, <EM>Change backup schedule</EM>, or just <EM>QEZ</EM>.</font><BR>
<input type=text name="query_entry">
<input type=hidden name="query">
<input type=hidden name="lang" value="">
<input type=hidden name="table_name" value="table">
<input type=hidden name="function" value="search">
<input type=hidden name="query_filter" value="">
<input type=hidden name="search_type" value="">
<input type=hidden name="sort_type" value="ascending">
<input type=hidden name="sort_column" value="apidescriptivename">
<input type=hidden name="field" value="_all">
<br><br><font size="-1">Show results containing:&nbsp;&nbsp;&nbsp;
<input type="radio" name="search_type_1" value="and" checked id="and"><label for="allwords1">All words</label>
<input type="radio" name="search_type_1" value="or" id="or"><label for="anywords1">Any words</label>
&nbsp;&nbsp;&nbsp;&nbsp;<INPUT TYPE="button" NAME="Go" VALUE="Go" onclick="goSearch()"></font>
</TD>
</TR>
</table>
</FORM>
<br>
<FORM NAME="form_2">
<table cellspacing="4" cellpadding="4" border="0" WIDTH="85%" ALIGN="CENTER">
<tr>
<td colspan="2" class="finderbar"><font size="+1"><STRONG>Find by group</strong></font></td>
</tr>
<tr>
<td width="15%"><BR><BR></td>
<td>
<table>
<tr>
<td>
<input type="radio" name="showall" value="desc" checked id="rad1">All APIs by descriptive name<br>
<input type="radio" name="showall" value="name" id="rad2">All APIs by API name<br>
<input type="radio" name="showall" value="new" id="rad3">All new APIs<br>
<input type="radio" name="showall" value="changed" id="rad4">All changed APIs<br>
<input type="radio" name="showall" value="exit" id="rad5">All exit programs
</td>
<td valign="center">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<INPUT TYPE="button" NAME="Show all alphabetically" VALUE="Go" onclick="goAlpha()">
</td>
</tr>
</table>
</td>
</tr>
</table>
</FORM>
<br>
<P><a name="note"><strong>Note:</strong></a>
Not all APIs that can be used on iSeries servers are available using this finder.
<br><br></P>
</BODY>
</HTML>