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

217 lines
19 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>Directory Services APIs</title>
<!-- Begin Header Records ========================================== -->
<!-- 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 -->
<!-- 030507 JETAYLOR replaced API and Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 031104 JETAYLOR replaced API and Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 031112 JETAYLOR replaced API and/or Exit listings with -->
<!-- pagegenerator output from javascript array -->
<!-- 041006 ROCH Add V5R4 new APIs -->
<!-- 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>
<h2>Lightweight Directory Access Protocol (LDAP) APIs</h2>
<p>The Lightweight Directory Access Protocol (LDAP) client APIs can be used to
access LDAP-enabled directories in a network. Administrative and configuration
APIs for IBM<SUP>(R)</SUP> Directory Server for iSeries<SUP>(TM)</SUP> are included.</p>
<p>Select one of the following for more information:</p>
<ul>
<li><a href="dirserv2.htm">LDAP API Overview</a></li>
<li><a href="dirserv3.htm">LDAP Version Support</a></li>
<li><a href="dirserv4.htm">Accessing Schema Information</a></li>
<li><a href="dirserv5.htm">API Prototype Changes</a></li>
<li><a href="dirserv6.htm">Deprecated APIs</a></li>
<li><a href="ldap_error_condt.htm">LDAP Client API Error Conditions</a></li>
</ul>
<p>The Lightweight Directory Access Protocol (LDAP) APIs are:</p>
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
<!-- Updates made in this section *will* be overlaid by automated tools -->
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
<!--***************API BEGIN PASTE***************-->
<ul>
<li><A HREF="ldap_abandon.htm">ldap_abandon</A> (Abandon an LDAP Operation in Progress)</li>
<li><A HREF="ldap_abandon_ext.htm">ldap_abandon_ext</A> (Abandon an LDAP Operation with Controls)</li>
<li><A HREF="ldap_add.htm">ldap_add</A> (Perform an LDAP Add Operation)</li>
<li><A HREF="ldap_add_control.htm">ldap_add_control</A> (Add New Server Control)</li>
<li><A HREF="ldap_add_ext.htm">ldap_add_ext</A> (Perform an LDAP Add Operation with Controls)</li>
<li><A HREF="ldap_add_ext_s.htm">ldap_add_ext_s</A> (Perform an LDAP Add Operation with Controls (Synchronous))</li>
<li><A HREF="ldap_add_s.htm">ldap_add_s</A> (Perform an LDAP Add Operation (Synchronous))</li>
<li><A HREF="ldap_app_ssl_client_init_np.htm">ldap_app_ssl_client_init_np</A> (Initialize the LDAP Client for a Secure Connection using DCM)</li>
<li><A HREF="ldap_app_ssl_init_np.htm">ldap_app_ssl_init_np</A> (Initialize an SSL Connection)</li>
<li><A HREF="ldap_app_ssl_start_np.htm">ldap_app_ssl_start_np</A> (Start a Secure LDAP Connection using DCM)</li>
<li><A HREF="ldap_ber_free.htm">ldap_ber_free</A> (Free storage allocated for BerElement)</li>
<li><A HREF="ldap_bind.htm">ldap_bind</A> (Perform an LDAP Bind Request)</li>
<li><A HREF="ldap_bind_s.htm">ldap_bind_s</A> (Perform an LDAP Bind Request (Synchronous))</li>
<li><A HREF="ldap_compare.htm">ldap_compare</A> (Perform an LDAP Compare Operation)</li>
<li><A HREF="ldap_cmp_ext.htm">ldap_compare_ext</A> (Perform an LDAP Compare Operation with Controls)</li>
<li><A HREF="ldap_cmp_ext_s.htm">ldap_compare_ext_s</A> (Perform an LDAP Compare Operation with Controls (Synchronous))</li>
<li><A HREF="ldap_compare_s.htm">ldap_compare_s</A> (Perform an LDAP Compare Operation (Synchronous))</li>
<li><A HREF="ldap_cntrl_free.htm">ldap_control_free</A> (Free Storage Allocated by the LDAP Library)</li>
<li><A HREF="ldap_cntrls_free.htm">ldap_controls_free</A> (Free an array of LDAPControl structures)</li>
<li><A HREF="ldap_copy_controls.htm">ldap_copy_controls</A> (Copy Control List)</li>
<li><A HREF="ldap_count_attr.htm">ldap_count_attributes</A> (Retrieve Count of Attributes for an LDAP Entry)</li>
<li><A HREF="ldap_count_entry.htm">ldap_count_entries</A> (Retrieve Count of LDAP Entries)</li>
<li><A HREF="ldap_count_msg.htm">ldap_count_messages</A> (Count messages in a result chain, as returned by ldap_result)</li>
<li><A HREF="ldap_count_ref.htm">ldap_count_references</A> (Count continuation references in a result chain of search results)</li>
<li><A HREF="ldap_count_value.htm">ldap_count_values</A> (Retrieve Count of Attribute Values)</li>
<li><A HREF="ldap_count_values_len.htm">ldap_count_values_len</A> (Retrieve Count of Binary Attribute Values)</li>
<li><A HREF="ldap_create_page_control.htm">ldap_create_page_control</A> (Create a Paged Results Control)</li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="ldap_create_proxyauth_control.htm">ldap_create_proxyauth_control()</A> (Create Control for Proxy Identity)&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><A HREF="ldap_create_sort_control.htm">ldap_create_sort_control</A> (Create a Sorted Results Control)</li>
<li><A HREF="ldap_create_sort_keylist.htm">ldap_create_sort_keylist</A> (Create a Structure with Sort Key Values)</li>
<li><A HREF="ldap_default_dn_get.htm">ldap_default_dn_get</A> (Retrieve the User's Default DN)</li>
<li><A HREF="ldap_default_dn_set.htm">ldap_default_dn_set</A> (Store the User's Default DN)</li>
<li><A HREF="ldap_delete.htm">ldap_delete</A> (Perform an LDAP Delete Operation)</li>
<li><A HREF="ldap_delete_ext.htm">ldap_delete_ext</A> (Perform an LDAP Delete Operation with Controls)</li>
<li><A HREF="ldap_delete_ext_s.htm">ldap_delete_ext_s</A> (Perform an LDAP Delete Operation with Controls (Synchronous))</li>
<li><A HREF="ldap_delete_s.htm">ldap_delete_s</A> (Perform an LDAP Delete Operation (Synchronous))</li>
<li><A HREF="ldap_dn2ufn.htm">ldap_dn2ufn</A> (Convert a Distinguished Name into a User Friendly Name)</li>
<li><A HREF="ldap_enetwork_domain_get.htm">ldap_enetwork_domain_get</A> (Retrieve the User's Default eNetwork Domain Name)</li>
<li><A HREF="ldap_enetwork_domain_set.htm">ldap_enetwork_domain_set</A> (Store the User's Default eNetwork Domain Name)</li>
<li><A HREF="ldap_err2string.htm">ldap_err2string</A> (Retrieve LDAP Error Message String)</li>
<li><A HREF="ldap_explode_dn.htm">ldap_explode_dn</A> (Break a Distinguished Name into Its Components)</li>
<li><A HREF="ldap_explode_dn_utf8.htm">ldap_explode_dn_utf8</A> (Break a UTF8 codepage Distinguished Name into Its Components)</li>
<li><A HREF="ldap_explode_dns.htm">ldap_explode_dns</A> (Break a DNS-style Distinguished Name into Its Components)</li>
<li><A HREF="ldap_explode_rdn.htm">ldap_explode_rdn</A> (Break a Relative Distinguished Name into Its Components)</li>
<li><A HREF="ldap_explode_rdn_utf8.htm">ldap_explode_rdn_utf8</A> (Break a UTF8 codepage Relative Distinguished Name into Its Components)</li>
<li><A HREF="ldap_extended_operation.htm">ldap_extended_operation</A> (Perform extended operations)</li>
<li><A HREF="ldap_extended_operation_s.htm">ldap_extended_operation_s</A> (Perform extended operations synchronously)</li>
<li><A HREF="ldap_first_attr.htm">ldap_first_attribute</A> (Retrieve First Attribute in an Entry)</li>
<li><A HREF="ldap_first_entry.htm">ldap_first_entry</A> (Retrieve First LDAP Entry)</li>
<li><A HREF="ldap_first_msg.htm">ldap_first_message</A> (Retrieve First LDAP Message)</li>
<li><A HREF="ldap_first_ref.htm">ldap_first_reference</A> (Return first continuation reference in a chain of search results)</li>
<li><A HREF="ldap_free_sort_keylist.htm">ldap_free_sort_keylist</A> (Free the Sort Key List Structure)</li>
<li><A HREF="ldap_free_urldesc.htm">ldap_free_urldesc</A> (Retrieve the Distinguished Name of an Entry)</li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="ldap_get_bind_controls.htm">ldap_get_bind_controls </A> (Get LDAP Bind Controls ) get controls sent by a LDAP server during a bind operation&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><A HREF="ldap_get_dn.htm">ldap_get_dn</A> (Extract the DN from an entry)</li>
<li><A HREF="ldap_get_entry_cntrls_np.htm">ldap_get_entry_controls_np</A> (Extract server controls from an entry)</li>
<li><A HREF="ldap_get_errno.htm">ldap_get_errno</A> (Retrieve Error Information)</li>
<li><A HREF="ldap_get_iconv_local_codepage.htm">ldap_get_iconv_local_codepage</A> (Get the Active LDAP Code Page)</li>
<li><A HREF="ldap_get_lderrno.htm">ldap_get_lderrno</A> (Retrieve Error Information)</li>
<li><A HREF="ldap_get_locale.htm">ldap_get_locale</A> (Get Active LDAP Locale)</li>
<li><A HREF="ldap_get_option.htm">ldap_get_option</A> (Retrieve LDAP Options)</li>
<li><A HREF="ldap_get_values.htm">ldap_get_values</A> (Retrieve a Set of Attribute Values from an Entry)</li>
<li><A HREF="ldap_get_values_len.htm">ldap_get_values_len</A> (Retrieve a Set of Binary Attribute Values)</li>
<li><A HREF="ldap_init.htm">ldap_init</A> (Perform an LDAP Initialization Operation)</li>
<li><A HREF="ldap_insert_control.htm">ldap_insert_control</A> (Insert Control into Control List)</li>
<li><A HREF="ldap_is_ldap_url.htm">ldap_is_ldap_url</A> (Verify LDAP URL)</li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="ldap_is_ldap_url_utf8.htm">ldap_is_ldap_url_utf8</A> (Verify UTF-8 Codepage LDAP URL) verifies UTF-8 codepage string is an LDAP URL.&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><A HREF="ldap_memfree.htm">ldap_memfree</A> (Free Memory Allocated by LDAP API)</li>
<li><A HREF="ldap_modify.htm">ldap_modify</A> (Perform an LDAP Modify Entry Request)</li>
<li><A HREF="ldap_modify_ext.htm">ldap_modify_ext</A> (Perform an LDAP Modify Entry Request with Controls)</li>
<li><A HREF="ldap_modify_ext_s.htm">ldap_modify_ext_s</A> (Perform an LDAP Modify Entry Request with Controls (Synchronous))</li>
<li><A HREF="ldap_modify_s.htm">ldap_modify_s</A> (Perform an LDAP Modify Entry Request (Synchronous))</li>
<li><A HREF="ldap_modrdn.htm">ldap_modrdn</A> (Perform an LDAP Modify RDN Request)</li>
<li><A HREF="ldap_modrdn_s.htm">ldap_modrdn_s</A> (Perform an LDAP Modify RDN Request (Synchronous))</li>
<li><A HREF="ldap_mods_free.htm">ldap_mods_free</A> (Free LDAP Modify Storage)</li>
<li><A HREF="ldap_msgfree.htm">ldap_msgfree</A> (Free LDAP Result Message)</li>
<li><A HREF="ldap_msgid.htm">ldap_msgid</A> (Retrieve Message ID Associated with an LDAP Message)</li>
<li><A HREF="ldap_msgtype.htm">ldap_msgtype</A> (Retrieve Type of an LDAP Message)</li>
<li><A HREF="ldap_next_attr.htm">ldap_next_attribute</A> (Retrieve Next Attribute in an Entry)</li>
<li><A HREF="ldap_next_entry.htm">ldap_next_entry</A> (Retrieve Next LDAP Entry)</li>
<li><A HREF="ldap_next_msg.htm">ldap_next_message</A> (Retrieve Next LDAP Message)</li>
<li><A HREF="ldap_next_ref.htm">ldap_next_reference</A> (Retrieve Next Continuation Reference in a Chain of Search Results)</li>
<li><A HREF="ldap_open.htm">ldap_open</A> (Perform an LDAP Open Operation)</li>
<li><A HREF="ldap_parse_extended_result.htm">ldap_parse_extended_result</A> (Parse extended result)</li>
<li><A HREF="ldap_parse_page_control.htm">ldap_parse_page_control</A> (Retrieve Values in a Paged Results Control)</li>
<li><A HREF="ldap_parse_pwdpolicy_response.htm">ldap_parse_pwdpolicy_response</A> (Obtain Error and Warning Codes from the Password Policy Response Control)</li>
<li><A HREF="ldap_parse_ref_np.htm">ldap_parse_reference_np</A> (Extract information from a continuation reference)</li>
<li><A HREF="ldap_parse_result.htm">ldap_parse_result</A> (Extract information from results)</li>
<li><A HREF="ldap_parse_sasl_bind_result.htm">ldap_parse_sasl_bind_result</A> (Extract server credentials from SASL bind results)</li>
<li><A HREF="ldap_parse_sort_control.htm">ldap_parse_sort_control</A> (Retrieve Values in a Sorted Results Control)</li>
<li><A HREF="ldap_perror.htm">ldap_perror</A> (Print LDAP Error Information)</li>
<li><A HREF="ldap_pwdpolicy_err2string.htm">ldap_pwdpolicy_err2string</A> (Convert Numeric Password Policy Error or Warning Code into a Message String)</li>
<li><A HREF="ldap_remove_control.htm">ldap_remove_control</A> (Remove Server Control)</li>
<li><A HREF="ldap_rename.htm">ldap_rename</A> (Asynchronously rename an entry)</li>
<li><A HREF="ldap_rename_s.htm">ldap_rename_s</A> (Synchronously rename an entry)</li>
<li><A HREF="ldap_result.htm">ldap_result</A> (Retrieve Result of an Asynchronous LDAP Operation)</li>
<li><A HREF="ldap_result2error.htm">ldap_result2error</A> (Retrieve LDAP Error Information)</li>
<li><A HREF="ldap_sasl_bind.htm">ldap_sasl_bind</A> (Perform an LDAP SASL Bind Request)</li>
<li><A HREF="ldap_sasl_bind_s.htm">ldap_sasl_bind_s</A> (Perform an LDAP SASL Bind Request (Synchronous))</li>
<li><A HREF="ldap_search.htm">ldap_search</A> (Perform an LDAP Search Operation)</li>
<li><A HREF="ldap_search_ext.htm">ldap_search_ext</A> (Asynchronously search the directory using controls)</li>
<li><A HREF="ldap_search_ext_s.htm">ldap_search_ext_s</A> (Synchronously search the directory using controls)</li>
<li><A HREF="ldap_search_s.htm">ldap_search_s</A> (Perform an LDAP Search Operation (Synchronous))</li>
<li><A HREF="ldap_search_st.htm">ldap_search_st</A> (Perform an LDAP Search Operation (Timed Synchronous))</li>
<li><A HREF="ldap_server_conf_save.htm">ldap_server_conf_save</A> (Store Server Information into Local Configuration)</li>
<li><A HREF="ldap_server_free_list.htm">ldap_server_free_list</A> (Free the List of LDAP Servers)</li>
<li><A HREF="ldap_server_locate.htm">ldap_server_locate</A> (Locate Suitable LDAP Servers)</li>
<li><A HREF="ldap_set_iconv_local_charset.htm">ldap_set_iconv_local_charset</A> (Set the Active LDAP Character Set)</li>
<li><A HREF="ldap_set_iconv_local_codepage.htm">ldap_set_iconv_local_codepage</A> (Set the Active LDAP Code Page)</li>
<li><A HREF="ldap_set_lderrno.htm">ldap_set_lderrno</A> (Set Error Information)</li>
<li><A HREF="ldap_set_locale.htm">ldap_set_locale</A> (Change the Locale Used by LDAP)</li>
<li><A HREF="ldap_set_option.htm">ldap_set_option</A> (Set LDAP Options)</li>
<li><A HREF="ldap_set_rebind_proc.htm">ldap_set_rebind_proc</A> (Set Rebind Procedure)</li>
<li><A HREF="ldap_simple_bind.htm">ldap_simple_bind</A> (Perform a Simple LDAP Bind Request)</li>
<li><A HREF="ldap_simple_bind_s.htm">ldap_simple_bind_s</A> (Perform a Simple LDAP Bind Request (Synchronous))</li>
<li><A HREF="ldap_ssl_client_init.htm">ldap_ssl_client_init</A> (Initialize the SSL library)</li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="ldap_ssl_environment_init.htm">ldap_ssl_environment_init()</A> (Initialize SSL for a secure connection)&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><A HREF="ldap_ssl_init.htm">ldap_ssl_init</A> (Initialize an SSL connection)</li>
<li><A HREF="ldap_ssl_start.htm">ldap_ssl_start</A> (Start a Secure LDAP Connection)</li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="ldap_start_tls_app_np.htm">ldap_start_tls_app_np()</A> (Start a TLS Session with an Application ID)&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="ldap_start_tls_s_np.htm">ldap_start_tls_s_np()</A> (Start a TLS Session with a Certificate)&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="ldap_stop_tls_s_np.htm">ldap_stop_tls_s_np()</A> (End a TLS Session)&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><A HREF="ldap_unbind.htm">ldap_unbind</A> (Perform an LDAP Unbind Request)</li>
<li><A HREF="ldap_unbind_ext.htm">ldap_unbind_ext</A> (Perform an LDAP Unbind Request)</li>
<li><A HREF="ldap_unbind_s.htm">ldap_unbind_s</A> (Perform an LDAP Unbind Request (Synchronous))</li>
<li><A HREF="ldap_url_parse.htm">ldap_url_parse</A> (Parse an LDAP URL)</li>
<li><A HREF="ldap_url_parse_utf8.htm">ldap_url_parse_utf8</A> (Parse a UTF8 codepage LDAP URL string)</li>
<li><A HREF="ldap_url_search.htm">ldap_url_search</A> (Perform an LDAP URL Search Operation)</li>
<li><A HREF="ldap_url_search_s.htm">ldap_url_search_s</A> (Perform an LDAP URL Search Operation (Synchronous))</li>
<li><A HREF="ldap_url_search_st.htm">ldap_url_search_st</A> (Perform an LDAP URL Search Operation (Timed Synchronous))</li>
<li><A HREF="ldap_value_free.htm">ldap_value_free</A> (Free memory allocated by ldap_get_values)</li>
<li><A HREF="ldap_value_free_len.htm">ldap_value_free_len</A> (Free Memory Allocated by ldap_get_values_len())</li>
<li><A HREF="ldap_version.htm">ldap_version</A> (Obtain LDAP version and SSL cipher information)</li>
<li><A HREF="ldap_xlate_local_to_unicode.htm">ldap_xlate_local_to_unicode</A> (Convert String From the Local Code Page to UCS-2 (or UNICODE) Encoding)</li>
<li><A HREF="ldap_xlate_local_to_utf8.htm">ldap_xlate_local_to_utf8</A> (Convert String From the Local Code Page to UTF-8 Encoding)</li>
<li><A HREF="ldap_xlate_unicode_to_local.htm">ldap_xlate_unicode_to_local</A> (Convert String From the UCS-2 (or UNICODE) Encoding to Local Code Page)</li>
<li><A HREF="ldap_xlate_utf8_to_local.htm">ldap_xlate_utf8_to_local</A> (Convert String From the UTF-8 Encoding to Local Code Page)</li>
<li><A HREF="QgldCfgDirSvr.htm">QgldCfgDirSvr</A> (Configure Directory Server) creates the initial IBM Directory Server configuration.</li>
<li><A HREF="QgldChgDirSvrA.htm">QgldChgDirSvrA</A> (Change Directory Server Attributes) changes the configuration of the IBM Directory Server.</li>
<li><img src="delta.gif" alt="Start of change" border="0"><A HREF="qgldcpyvl.htm">QGLDCPYVL</A> (Copy Validation List To Directory) copies internet users defined in a validation list to the local IBM Directory Server.&nbsp;<img src="deltaend.gif" ALT="End of change" border="0"></li>
<li><A HREF="QgldExportLdif.htm">QgldExportLdif</A> (Export LDIF File) exports the IBM Directory Server contents to an LDIF file.</li>
<li><A HREF="QgldImportLdif.htm">QgldImportLdif</A> (Import LDIF File) imports an LDIF file to the IBM Directory Server.</li>
<li><A HREF="QgldLstDirSvrA.htm">QgldLstDirSvrA</A> (List Directory Server Attributes) retrieves a list of IBM Directory Server attributes.</li>
<li><A HREF="QgldPubDirObj.htm">QgldPubDirObj</A> (Publish Directory Object) publishes an object to an LDAP server.</li>
<li><A HREF="QgldRtvDirSvrA.htm">QgldRtvDirSvrA</A> (Retrieve Directory Server Attributes) retrieves configuration settings for the IBM Directory Server.</li>
<li><A HREF="QGLDSSDD.htm">QGLDSSDD</A> (Synchronize System Distribution Directory to LDAP) publishes system distribution directory entries to an LDAP directory.</li>
</ul>
<!--***************API END PASTE***************-->
<br>
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>