iSeries Navigator API listing

The iSeries™ Navigator APIs listed and grouped by function.

Function iSeries Navigator APIs
System values: This API allows the plug-in developer to obtain the current value of an iSeries system value.

cwbUN_GetSystemValue

System handles: 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.

cwbUN_GetSystemHandle

cwbUN_ReleaseSystemHandle

User input validation: 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.

cwbUN_CheckObjectAuthority

cwbUN_CheckSpecialAuthority

User authority checking: 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.

cwbUN_CheckAS400Name

User profile attributes: This API allows the plug-in developer to obtain the value of any of the user profile attributes for the current iSeries Navigator user.

cwbUN_GetUserAttribute

Data management: 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.

cwbUN_ConvertPidlToString

cwbUN_GetDisplayNameFromItemId

cwbUN_GetDisplayNameFromName

cwbUN_GetDisplayPathFromName

cwbUN_GetIndexFromItemId

cwbUN_GetIndexFromName

cwbUN_GetIndexFromPidl

cwbUN_GetListObject

cwbUN_GetParentFolderNameFromName

cwbUN_GetParentFolderPathFromName

cwbUN_GetParentFolderPidl

cwbUN_GetSystemNameFromName

cwbUN_GetSystemNameFromPidl

cwbUN_GetSystemNameFromPidl

cwbUN_GetTypeFromName

cwbUN_GetTypeFromPidl

Refresh the iSeries Navigator window: 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.

cwbUN_RefreshAll

cwbUN_RefreshList

cwbUN_RefreshListItems

cwbUN_UpdateStatusBar

ODBC connections: 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.

cwbUN_GetODBCConnection

cwbUN_EndODBCConnections

Access iSeries Navigator icons: These APIs allow the plug-in developer to access the icon image lists for objects that appear in the Navigator object hierarchy.

cwbUN_GetIconIndex

cwbUN_GetSharedImageList

Application Administration: These APIs allow the plug-in developer to programmatically determine whether a user is denied or allowed use of an Administrable function. An Administrable function is any function whose use can be controlled through the Application Administration sub component of iSeries Navigator.

cwbUN_GetAdminValue

cwbUN_GetAdminValueEx

cwbUN_GetAdminCacheState

cwbUN_GetAdminCacheStateEx

Install: This API allows the plug-in developer to determine if an iSeries Navigator sub component is installed.

cwbUN_IsSubcomponentInstalled

Directory Services: 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®. 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.

Functions that use strings are available in ANSI and Unicode versions.

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.

cwbUN_OpenLocalLdapServer

cwbUN_FreeLocalLdapServer

cwbUN_GetLdapSvrPort

cwbUN_GetLdapSvrSuffixCount

cwbUN_GetLdapSvrSuffixName

cwbUN_OpenLdapPublishing

cwbUN_FreeLdapPublishing

cwbUN_GetLdapPublishCount

cwbUN_GetLdapPublishType

cwbUN_GetLdapPublishServer

cwbUN_GetLdapPublishPort

cwbUN_GetLdapPublishParentDn