ldap_free_urldesc()--Free an LDAP URL Description
Syntax
#include <ldap.h> typedef struct ldap_url_desc { char *lud_host; /* LDAP host to contact */ int lud_port; /* port on host */ char *lud_dn; /* base for search */ char **lud_attrs; /* NULL-terminate list of attributes */ int lud_scope; /* a valid LDAP_SCOPE_... value */ char *lud_filter; /* LDAP search filter */ char *lud_string; /* for internal use only */ } LDAPURLDesc; void ldap_free_urldesc( LDAPURLDesc *ludp)
Library Name/Service Program: QSYS/QGLDCLNT
Default Public Authority: *USE
Threadsafe: Yes
The ldap_free_urldesc() function is called to free an LDAP URL description that was obtained from a call to the ldap_url_parse() function.
Authorities and Locks
No IBM® i authority is required.
Parameters
- ludp
- (Input) Points to the LDAP URL description, as returned by ldap_url_parse().
Return Value
None.
Error Conditions
The ldap_free_urldesc() API does not return an error code.
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_free_urldesc API. |
Related Information
- ldap_is_ldap_url() -- Check a URL string to see if it is an LDAP URL.
- ldap_url_parse() -- Break up an LDAP URL string into its components.
- ldap_url_search() -- Asynchronously search using an LDAP URL.
- ldap_url_search_s() -- Synchronously search using an LDAP URL.
- ldap_url_search_st() -- Synchronously search using an LDAP URL and a timeout.
API introduced: V4R3
[ Back to top | LDAP APIs | APIs by category ]