174 lines
10 KiB
HTML
174 lines
10 KiB
HTML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE html
|
||
|
|
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html lang="en-us" xml:lang="en-us">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2005" />
|
||
|
|
<meta name="DC.rights.owner" content="(C) Copyright IBM Corporation 2005" />
|
||
|
|
<meta name="security" content="public" />
|
||
|
|
<meta name="Robots" content="index,follow" />
|
||
|
|
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
|
||
|
|
<meta name="DC.Type" content="concept" />
|
||
|
|
<meta name="DC.Title" content="iSeries Navigator API listing" />
|
||
|
|
<meta name="abstract" content="The iSeries Navigator APIs listed and grouped by function." />
|
||
|
|
<meta name="description" content="The iSeries Navigator APIs listed and grouped by function." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzakxapis.htm" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzakxapilist" />
|
||
|
|
<meta name="DC.Language" content="en-us" />
|
||
|
|
<!-- 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. -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="./ic.css" />
|
||
|
|
<title>iSeries Navigator
|
||
|
|
API listing</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzakxapilist"><a name="rzakxapilist"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">iSeries Navigator
|
||
|
|
API listing</h1>
|
||
|
|
<div><p>The iSeries™ Navigator
|
||
|
|
APIs listed and grouped by function.</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th valign="top" id="d0e20">Function</th>
|
||
|
|
<th valign="top" id="d0e22">iSeries Navigator
|
||
|
|
APIs</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e20 "><span class="uicontrol">System values:</span> This API allows the plug-in developer
|
||
|
|
to obtain the current value of an iSeries system value.</td>
|
||
|
|
<td valign="top" headers="d0e22 "><p><a href="rzakxcwbungetsystemvalue.htm">cwbUN_GetSystemValue</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>System handles:</strong> These APIs allow the plug-in developer to obtain
|
||
|
|
and to release the current value of an iSeries system object handle that contains
|
||
|
|
connection properties including the secure sockets layer (SSL) settings to
|
||
|
|
be used for the specified iSeries system.</td>
|
||
|
|
<td valign="top" headers="d0e22 "><p><a href="rzakxcwbungetsystemhandle.htm">cwbUN_GetSystemHandle</a></p>
|
||
|
|
<p><a href="rzakxcwbunreleasesystemhandle.htm">cwbUN_ReleaseSystemHandle</a> </p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>User input validation:</strong> These APIs allow the plug-in developer
|
||
|
|
to check whether the current user has authority to a particular iSeries object.
|
||
|
|
The APIs also allow the developer to determine if the user has one or more
|
||
|
|
special authorities.</td>
|
||
|
|
<td valign="top" headers="d0e22 "> <p><a href="rzakxcwbuncheckobjectauthor.htm">cwbUN_CheckObjectAuthority</a></p>
|
||
|
|
<p><a href="rzakxcwbuncheckspecialautho.htm">cwbUN_CheckSpecialAuthority</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>User authority checking:</strong> This API allows the plug-in developer
|
||
|
|
to check whether certain types of user-supplied strings are valid before transmitting
|
||
|
|
them to the iSeries server.</td>
|
||
|
|
<td valign="top" headers="d0e22 "><p><a href="rzakxcwbuncheckas400name.htm">cwbUN_CheckAS400Name</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>User profile attributes:</strong> This API allows the plug-in developer
|
||
|
|
to obtain the value of any of the user profile attributes for the current iSeries Navigator
|
||
|
|
user.</td>
|
||
|
|
<td valign="top" headers="d0e22 "> <p><a href="rzakxcwbungetuserattribute.htm">cwbUN_GetUserAttribute</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>Data management:</strong> Objects that the user has selected are identified
|
||
|
|
to the third-party plug-in by two data entities, the item identifier list,
|
||
|
|
and the object name. Data management APIs provide the plug-in developer with
|
||
|
|
a means of extracting information from these structures.</td>
|
||
|
|
<td valign="top" headers="d0e22 "><p><a href="rzakxcwbunconvertpidltostri.htm">cwbUN_ConvertPidlToString</a></p>
|
||
|
|
<p><a href="rzakxcwbungetdisplaynameiid.htm">cwbUN_GetDisplayNameFromItemId</a></p>
|
||
|
|
<p><a href="rzakxcwbungetdisplaynamenme.htm">cwbUN_GetDisplayNameFromName</a></p>
|
||
|
|
<p><a href="rzakxcwbungetdisplaypathnme.htm">cwbUN_GetDisplayPathFromName</a></p>
|
||
|
|
<p><a href="rzakxcwbungetindexfromitemi.htm">cwbUN_GetIndexFromItemId</a></p>
|
||
|
|
<p><a href="rzakxcwbungetindexfromname.htm">cwbUN_GetIndexFromName</a></p>
|
||
|
|
<p><a href="rzakxcwbungetindexfrompidl.htm">cwbUN_GetIndexFromPidl</a></p>
|
||
|
|
<p><a href="rzakxcwbungetlistobject.htm">cwbUN_GetListObject</a></p>
|
||
|
|
<p><a href="rzakxcwbungetparentfolderna.htm">cwbUN_GetParentFolderNameFromName</a></p>
|
||
|
|
<p><a href="rzakxcwbungetparentfolderpa.htm">cwbUN_GetParentFolderPathFromName</a></p>
|
||
|
|
<p><a href="rzakxcwbungetparentfolderpi.htm">cwbUN_GetParentFolderPidl</a></p>
|
||
|
|
<p><a href="rzakxcwbungetsystemnamename.htm">cwbUN_GetSystemNameFromName</a></p>
|
||
|
|
<p><a href="rzakxcwbungetsystemnamepidl.htm">cwbUN_GetSystemNameFromPidl</a></p>
|
||
|
|
<p><a href="rzakxcwbungetsystemnamepidl.htm">cwbUN_GetSystemNameFromPidl</a></p>
|
||
|
|
<p><a href="rzakxcwbungettypefromname.htm">cwbUN_GetTypeFromName</a></p>
|
||
|
|
<p><a href="rzakxcwbungettypefrompidl.htm">cwbUN_GetTypeFromPidl</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>Refresh the iSeries Navigator window:</strong> Following the completion
|
||
|
|
of an operation on behalf of the user, these APIs enable execution of a request
|
||
|
|
by the plug-in to refresh the tree and list views or to place a message in
|
||
|
|
the Navigator status bar.</td>
|
||
|
|
<td valign="top" headers="d0e22 "><p><a href="rzakxcwbunrefreshall.htm">cwbUN_RefreshAll</a></p>
|
||
|
|
<p><a href="rzakxcwbunrefreshlist.htm">cwbUN_RefreshList</a></p>
|
||
|
|
<p><a href="rzakxcwbunrefreshlistitems.htm">cwbUN_RefreshListItems</a></p>
|
||
|
|
<p><a href="rzakxcwbunupdatestatusbar.htm">cwbUN_UpdateStatusBar</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>ODBC connections:</strong> These APIs allow the plug-in developer to
|
||
|
|
reuse and end the handle for an ODBC connection that already has been obtained
|
||
|
|
by the Database component of the iSeries Navigator.</td>
|
||
|
|
<td valign="top" headers="d0e22 "> <p><a href="rzakxcwbungetodbcconnection.htm">cwbUN_GetODBCConnection</a> </p>
|
||
|
|
<p><a href="rzakxcwbunendodbcconnections.htm">cwbUN_EndODBCConnections</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>Access iSeries Navigator icons:</strong> These APIs allow the plug-in
|
||
|
|
developer to access the icon image lists for objects that appear in the Navigator
|
||
|
|
object hierarchy.</td>
|
||
|
|
<td valign="top" headers="d0e22 "> <p><a href="rzakxcwbungeticonindex.htm">cwbUN_GetIconIndex</a></p>
|
||
|
|
<p><a href="rzakxcwbungetsharedimagelis.htm">cwbUN_GetSharedImageList</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>Application Administration:</strong> These APIs allow the plug-in developer
|
||
|
|
to programmatically determine whether a user is denied or allowed use of an
|
||
|
|
Administrable function. An <span class="uicontrol">Administrable function</span> is
|
||
|
|
any function whose use can be controlled through the Application Administration
|
||
|
|
sub component of iSeries Navigator.</td>
|
||
|
|
<td valign="top" headers="d0e22 "><p><a href="rzakxcwbungetadminvalue.htm">cwbUN_GetAdminValue</a></p>
|
||
|
|
<p><a href="rzakxcwbungetadminvalueex.htm">cwbUN_GetAdminValueEx</a></p>
|
||
|
|
<p><a href="rzakxcwbungetadmincachestat.htm">cwbUN_GetAdminCacheState</a> </p>
|
||
|
|
<p><a href="rzakxcwbungetadmincachestateex.htm">cwbUN_GetAdminCacheStateEx</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>Install:</strong> This API allows the plug-in developer to determine
|
||
|
|
if an iSeries Navigator
|
||
|
|
sub component is installed.</td>
|
||
|
|
<td valign="top" headers="d0e22 "><p><a href="rzakxcwbunissubcomponentins.htm">cwbUN_IsSubcomponentInstalled</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e20 "><strong>Directory Services:</strong> These APIs provide information about the
|
||
|
|
Directory Services (LDAP) server on an iSeries computer, and functions to connect
|
||
|
|
to the server. The connection functions enable you to connect to a server
|
||
|
|
using information (distinguished names, password, etc.) cached by the iSeries Access
|
||
|
|
for Windows<sup>®</sup>.
|
||
|
|
The connection functions use the LDAP client shipped with iSeries Access
|
||
|
|
for Windows (LDAP.LIB
|
||
|
|
and LDAP.DLL) and therefore require that your application use that client. <p>Functions
|
||
|
|
that use strings are available in ANSI and Unicode versions.</p>
|
||
|
|
<p>Functions
|
||
|
|
that return distinguished names and other strings for use with LDAP client
|
||
|
|
APIs also are provided in a UTF-8 version for use with LDAP version 3 servers.</p>
|
||
|
|
</td>
|
||
|
|
<td valign="top" headers="d0e22 "> <p><a href="rzakxcwbunopenlocalldapserv.htm">cwbUN_OpenLocalLdapServer</a></p>
|
||
|
|
<p><a href="rzakxcwbunfreelocalldapserv.htm">cwbUN_FreeLocalLdapServer</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldapsvrport.htm">cwbUN_GetLdapSvrPort</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldapsvrsuffixc.htm">cwbUN_GetLdapSvrSuffixCount</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldapsvrsuffixn.htm">cwbUN_GetLdapSvrSuffixName</a></p>
|
||
|
|
<p><a href="rzakxcwbunopenldappublishin.htm">cwbUN_OpenLdapPublishing</a></p>
|
||
|
|
<p><a href="rzakxcwbunfreeldappublishin.htm">cwbUN_FreeLdapPublishing</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldappublishcou.htm">cwbUN_GetLdapPublishCount</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldappublishtyp.htm">cwbUN_GetLdapPublishType</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldappublishser.htm">cwbUN_GetLdapPublishServer</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldappublishpor.htm">cwbUN_GetLdapPublishPort</a></p>
|
||
|
|
<p><a href="rzakxcwbungetldappublishpar.htm">cwbUN_GetLdapPublishParentDn</a></p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakxapis.htm" title="iSeries Navigator APIs help plug-in developers obtain and manage certain types of global information.">iSeries Navigator APIs</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|