ldap_server_free_list()-- Free the List of LDAP Servers

Syntax

 #include <ldap.h>

 int  ldap_server_free_list(
        LDAPServerInfo   *server_info_listp );

  Default Public Authority: *USE

  Library Name/Service Program: QSYS/QGLDCLNT

  Threadsafe: Yes

The ldap_server_free_list() API is used to free the linked list of LDAPServerInfo structures (and all associated storage) as returned from the ldap_server_locate() API.

Authorities and Locks

No IBM^® i authority is required.

Parameters

server_info_listp: (Input) The address of a linked list of LDAPServerInfo structures to be freed.

Return Value

LDAP_SUCCESS: if the request was successful.
another LDAP error code: if the request was not successful.

Error Conditions

If ldap_server_free_list() is not successful, an error code will be returned. See LDAP Client API Error Conditions for possible LDAP error code values.

Error Messages

The following message may be sent from this function.

Message ID	Error Message Text
CPF3CF2 E	Error(s) occurred during running of ldap_server_free_list API.

Related Information

ldap_server_conf_save() -- Store server information into local configuration.
ldap_server_locate() -- Locate suitable LDAP servers.

API introduced: V4R5

[ Back to top | LDAP APIs | APIs by category ]