Directory Services APIs

Lightweight Directory Access Protocol (LDAP) APIs

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^(R) Directory Server for iSeries^(TM) are included.

Select one of the following for more information:

The Lightweight Directory Access Protocol (LDAP) APIs are:

ldap_abandon (Abandon an LDAP Operation in Progress)
ldap_abandon_ext (Abandon an LDAP Operation with Controls)
ldap_add (Perform an LDAP Add Operation)
ldap_add_control (Add New Server Control)
ldap_add_ext (Perform an LDAP Add Operation with Controls)
ldap_add_ext_s (Perform an LDAP Add Operation with Controls (Synchronous))
ldap_add_s (Perform an LDAP Add Operation (Synchronous))
ldap_app_ssl_client_init_np (Initialize the LDAP Client for a Secure Connection using DCM)
ldap_app_ssl_init_np (Initialize an SSL Connection)
ldap_app_ssl_start_np (Start a Secure LDAP Connection using DCM)
ldap_ber_free (Free storage allocated for BerElement)
ldap_bind (Perform an LDAP Bind Request)
ldap_bind_s (Perform an LDAP Bind Request (Synchronous))
ldap_compare (Perform an LDAP Compare Operation)
ldap_compare_ext (Perform an LDAP Compare Operation with Controls)
ldap_compare_ext_s (Perform an LDAP Compare Operation with Controls (Synchronous))
ldap_compare_s (Perform an LDAP Compare Operation (Synchronous))
ldap_control_free (Free Storage Allocated by the LDAP Library)
ldap_controls_free (Free an array of LDAPControl structures)
ldap_copy_controls (Copy Control List)
ldap_count_attributes (Retrieve Count of Attributes for an LDAP Entry)
ldap_count_entries (Retrieve Count of LDAP Entries)
ldap_count_messages (Count messages in a result chain, as returned by ldap_result)
ldap_count_references (Count continuation references in a result chain of search results)
ldap_count_values (Retrieve Count of Attribute Values)
ldap_count_values_len (Retrieve Count of Binary Attribute Values)
ldap_create_page_control (Create a Paged Results Control)
ldap_create_proxyauth_control() (Create Control for Proxy Identity)
ldap_create_sort_control (Create a Sorted Results Control)
ldap_create_sort_keylist (Create a Structure with Sort Key Values)
ldap_default_dn_get (Retrieve the User's Default DN)
ldap_default_dn_set (Store the User's Default DN)
ldap_delete (Perform an LDAP Delete Operation)
ldap_delete_ext (Perform an LDAP Delete Operation with Controls)
ldap_delete_ext_s (Perform an LDAP Delete Operation with Controls (Synchronous))
ldap_delete_s (Perform an LDAP Delete Operation (Synchronous))
ldap_dn2ufn (Convert a Distinguished Name into a User Friendly Name)
ldap_enetwork_domain_get (Retrieve the User's Default eNetwork Domain Name)
ldap_enetwork_domain_set (Store the User's Default eNetwork Domain Name)
ldap_err2string (Retrieve LDAP Error Message String)
ldap_explode_dn (Break a Distinguished Name into Its Components)
ldap_explode_dn_utf8 (Break a UTF8 codepage Distinguished Name into Its Components)
ldap_explode_dns (Break a DNS-style Distinguished Name into Its Components)
ldap_explode_rdn (Break a Relative Distinguished Name into Its Components)
ldap_explode_rdn_utf8 (Break a UTF8 codepage Relative Distinguished Name into Its Components)
ldap_extended_operation (Perform extended operations)
ldap_extended_operation_s (Perform extended operations synchronously)
ldap_first_attribute (Retrieve First Attribute in an Entry)
ldap_first_entry (Retrieve First LDAP Entry)
ldap_first_message (Retrieve First LDAP Message)
ldap_first_reference (Return first continuation reference in a chain of search results)
ldap_free_sort_keylist (Free the Sort Key List Structure)
ldap_free_urldesc (Retrieve the Distinguished Name of an Entry)
ldap_get_bind_controls (Get LDAP Bind Controls ) get controls sent by a LDAP server during a bind operation
ldap_get_dn (Extract the DN from an entry)
ldap_get_entry_controls_np (Extract server controls from an entry)
ldap_get_errno (Retrieve Error Information)
ldap_get_iconv_local_codepage (Get the Active LDAP Code Page)
ldap_get_lderrno (Retrieve Error Information)
ldap_get_locale (Get Active LDAP Locale)
ldap_get_option (Retrieve LDAP Options)
ldap_get_values (Retrieve a Set of Attribute Values from an Entry)
ldap_get_values_len (Retrieve a Set of Binary Attribute Values)
ldap_init (Perform an LDAP Initialization Operation)
ldap_insert_control (Insert Control into Control List)
ldap_is_ldap_url (Verify LDAP URL)
ldap_is_ldap_url_utf8 (Verify UTF-8 Codepage LDAP URL) verifies UTF-8 codepage string is an LDAP URL.
ldap_memfree (Free Memory Allocated by LDAP API)
ldap_modify (Perform an LDAP Modify Entry Request)
ldap_modify_ext (Perform an LDAP Modify Entry Request with Controls)
ldap_modify_ext_s (Perform an LDAP Modify Entry Request with Controls (Synchronous))
ldap_modify_s (Perform an LDAP Modify Entry Request (Synchronous))
ldap_modrdn (Perform an LDAP Modify RDN Request)
ldap_modrdn_s (Perform an LDAP Modify RDN Request (Synchronous))
ldap_mods_free (Free LDAP Modify Storage)
ldap_msgfree (Free LDAP Result Message)
ldap_msgid (Retrieve Message ID Associated with an LDAP Message)
ldap_msgtype (Retrieve Type of an LDAP Message)
ldap_next_attribute (Retrieve Next Attribute in an Entry)
ldap_next_entry (Retrieve Next LDAP Entry)
ldap_next_message (Retrieve Next LDAP Message)
ldap_next_reference (Retrieve Next Continuation Reference in a Chain of Search Results)
ldap_open (Perform an LDAP Open Operation)
ldap_parse_extended_result (Parse extended result)
ldap_parse_page_control (Retrieve Values in a Paged Results Control)
ldap_parse_pwdpolicy_response (Obtain Error and Warning Codes from the Password Policy Response Control)
ldap_parse_reference_np (Extract information from a continuation reference)
ldap_parse_result (Extract information from results)
ldap_parse_sasl_bind_result (Extract server credentials from SASL bind results)
ldap_parse_sort_control (Retrieve Values in a Sorted Results Control)
ldap_perror (Print LDAP Error Information)
ldap_pwdpolicy_err2string (Convert Numeric Password Policy Error or Warning Code into a Message String)
ldap_remove_control (Remove Server Control)
ldap_rename (Asynchronously rename an entry)
ldap_rename_s (Synchronously rename an entry)
ldap_result (Retrieve Result of an Asynchronous LDAP Operation)
ldap_result2error (Retrieve LDAP Error Information)
ldap_sasl_bind (Perform an LDAP SASL Bind Request)
ldap_sasl_bind_s (Perform an LDAP SASL Bind Request (Synchronous))
ldap_search (Perform an LDAP Search Operation)
ldap_search_ext (Asynchronously search the directory using controls)
ldap_search_ext_s (Synchronously search the directory using controls)
ldap_search_s (Perform an LDAP Search Operation (Synchronous))
ldap_search_st (Perform an LDAP Search Operation (Timed Synchronous))
ldap_server_conf_save (Store Server Information into Local Configuration)
ldap_server_free_list (Free the List of LDAP Servers)
ldap_server_locate (Locate Suitable LDAP Servers)
ldap_set_iconv_local_charset (Set the Active LDAP Character Set)
ldap_set_iconv_local_codepage (Set the Active LDAP Code Page)
ldap_set_lderrno (Set Error Information)
ldap_set_locale (Change the Locale Used by LDAP)
ldap_set_option (Set LDAP Options)
ldap_set_rebind_proc (Set Rebind Procedure)
ldap_simple_bind (Perform a Simple LDAP Bind Request)
ldap_simple_bind_s (Perform a Simple LDAP Bind Request (Synchronous))
ldap_ssl_client_init (Initialize the SSL library)
ldap_ssl_environment_init() (Initialize SSL for a secure connection)
ldap_ssl_init (Initialize an SSL connection)
ldap_ssl_start (Start a Secure LDAP Connection)
ldap_start_tls_app_np() (Start a TLS Session with an Application ID)
ldap_start_tls_s_np() (Start a TLS Session with a Certificate)
ldap_stop_tls_s_np() (End a TLS Session)
ldap_unbind (Perform an LDAP Unbind Request)
ldap_unbind_ext (Perform an LDAP Unbind Request)
ldap_unbind_s (Perform an LDAP Unbind Request (Synchronous))
ldap_url_parse (Parse an LDAP URL)
ldap_url_parse_utf8 (Parse a UTF8 codepage LDAP URL string)
ldap_url_search (Perform an LDAP URL Search Operation)
ldap_url_search_s (Perform an LDAP URL Search Operation (Synchronous))
ldap_url_search_st (Perform an LDAP URL Search Operation (Timed Synchronous))
ldap_value_free (Free memory allocated by ldap_get_values)
ldap_value_free_len (Free Memory Allocated by ldap_get_values_len())
ldap_version (Obtain LDAP version and SSL cipher information)
ldap_xlate_local_to_unicode (Convert String From the Local Code Page to UCS-2 (or UNICODE) Encoding)
ldap_xlate_local_to_utf8 (Convert String From the Local Code Page to UTF-8 Encoding)
ldap_xlate_unicode_to_local (Convert String From the UCS-2 (or UNICODE) Encoding to Local Code Page)
ldap_xlate_utf8_to_local (Convert String From the UTF-8 Encoding to Local Code Page)
QgldCfgDirSvr (Configure Directory Server) creates the initial IBM Directory Server configuration.
QgldChgDirSvrA (Change Directory Server Attributes) changes the configuration of the IBM Directory Server.
QGLDCPYVL (Copy Validation List To Directory) copies internet users defined in a validation list to the local IBM Directory Server.
QgldExportLdif (Export LDIF File) exports the IBM Directory Server contents to an LDIF file.
QgldImportLdif (Import LDIF File) imports an LDIF file to the IBM Directory Server.
QgldLstDirSvrA (List Directory Server Attributes) retrieves a list of IBM Directory Server attributes.
QgldPubDirObj (Publish Directory Object) publishes an object to an LDAP server.
QgldRtvDirSvrA (Retrieve Directory Server Attributes) retrieves configuration settings for the IBM Directory Server.
QGLDSSDD (Synchronize System Distribution Directory to LDAP) publishes system distribution directory entries to an LDAP directory.

APIs by category