Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

cldap_search_s(3ldap) [opensolaris man page]

cldap_search_s(3LDAP)					      LDAP Library Functions					     cldap_search_s(3LDAP)

NAME
cldap_search_s - connectionless LDAP search SYNOPSIS
cc[ flag... ] file... -lldap[ library... ] #include <lber.h> #include <ldap.h> int cldap_search_s(LDAP *ld, char *base, int scope, char *filter, char *attrs, int attrsonly, LDAPMessage **res, char *logdn); DESCRIPTION
The cldap_search_s() function performs an LDAP search using the Connectionless LDAP (CLDAP) protocol. cldap_search_s() has parameters and behavior identical to that of ldap_search_s(3LDAP), except for the addition of the logdn parameter. logdn should contain a distinguished name to be used only for logging purposed by the LDAP server. It should be in the text format described by RFC 1779, A String Representation of Distinguished Names. Retransmission Algorithm cldap_search_s() operates using the CLDAP protocol over udp(7P). Since UDP is a non-reliable protocol, a retry mechanism is used to increase reliability. The cldap_setretryinfo(3LDAP) function can be used to set two retry parameters: tries, a count of the number of times to send a search request and timeout, an initial timeout that determines how long to wait for a response before re-trying. timeout is specified seconds. These values are stored in the ld_cldaptries and ld_cldaptimeout members of the ld LDAP structure, and the default val- ues set in ldap_open(3LDAP) are 4 and 3 respectively. The retransmission algorithm used is: Step 1 Set the current timeout to ld_cldaptimeout seconds, and the current LDAP server address to the first LDAP server found during the ldap_open(3LDAP) call. Step 2 Send the search request to the current LDAP server address. Step 3 Set the wait timeout to the current timeout divided by the number of server addresses found during ldap_open(3LDAP) or to one second, whichever is larger. Wait at most that long for a response; if a response is received, STOP. Note that the wait timeout is always rounded down to the next lowest second. Step 4 Repeat steps 2 and 3 for each LDAP server address. Step 5 Set the current timeout to twice its previous value and repeat Steps 2 through 5 a maximum of tries times. EXAMPLES
Assume that the default values for tries and timeout of 4 tries and 3 seconds are used. Further, assume that a space-separated list of two hosts, each with one address, was passed to cldap_open(3LDAP). The pattern of requests sent will be (stopping as soon as a response is received): Time Search Request Sent To: +0 Host A try 1 +1 (0+3/2) Host B try 1 +2 (1+3/2) Host A try 2 +5 (2+6/2) Host B try 2 +8 (5+6/2) Host A try 3 +14 (8+12/2) Host B try 3 +20 (14+12/2) Host A try 4 +32 (20+24/2) Host B try 4 +44 (20+24/2) (give up - no response) ERRORS
cldap_search_s() returns LDAP_SUCCESS if a search was successful and the appropriate LDAP error code otherwise. See ldap_error(3LDAP) for more information. ATTRIBUTES
See attributes(5) for a description of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |Availability |SUNWcsl (32-bit) | | |SUNWcslx (64-bit) | |Interface Stability |Evolving | +-----------------------------+-----------------------------+ SEE ALSO
ldap(3LDAP), ldap_error(3LDAP), ldap_search_s(3LDAP), cldap_open(3LDAP), cldap_setretryinfo(3LDAP), cldap_close(3LDAP), attributes(5), udp(7P) SunOS 5.11 27 Jan 2002 cldap_search_s(3LDAP)

Check Out this Related Man Page

ldap_first_entry(3LDAP) 				      LDAP Library Functions					   ldap_first_entry(3LDAP)

NAME
ldap_first_entry, ldap_next_entry, ldap_count_entries, ldap_count_references, ldap_first_reference, ldap_next_reference - LDAP entry pars- ing and counting functions SYNOPSIS
cc[ flag... ] file... -lldap[ library... ] #include <lber.h> #include <ldap.h> LDAPMessage *ldap_first_entry(LDAP*ld, LDAPMessage *result); LDAPMessage *ldap_next_entry(LDAP *ld, LDAPMessage *entry); ldap_count_entries(LDAP *ld, LDAPMessage *result); LDAPMessage *ldap_first_reference(LDAP *ld, LDAPMessage *res); LDAPMessage *ldap_next_reference(LDAP *ld, LDAPMessage *res); int ldap_count_references(LDAP *ld, LDAPMessage *res); DESCRIPTION
These functions are used to parse results received from ldap_result(3LDAP) or the synchronous LDAP search operation functions ldap_search_s(3LDAP) and ldap_search_st(3LDAP). The ldap_first_entry() function is used to retrieve the first entry in a chain of search results. It takes the result as returned by a call to ldap_result(3LDAP) or ldap_search_s(3LDAP) or ldap_search_st(3LDAP) and returns a pointer to the first entry in the result. This pointer should be supplied on a subsequent call to ldap_next_entry() to get the next entry, the result of which should be supplied to the next call to ldap_next_entry(), etc. ldap_next_entry() will return NULL when there are no more entries. The entries returned from these calls are used in calls to the functions described in ldap_get_dn(3LDAP), ldap_first_attribute(3LDAP), ldap_get_values(3LDAP), etc. A count of the number of entries in the search result can be obtained by calling ldap_count_entries(). ldap_first_reference() and ldap_next_reference() are used to step through and retrieve the list of continuation references from a search result chain. The ldap_count_references() function is used to count the number of references that are contained in and remain in a search result chain. ERRORS
If an error occurs in ldap_first_entry() or ldap_next_entry(), NULL is returned and the ld_errno field in the ld parameter is set to indi- cate the error. If an error occurs in ldap_count_entries(), -1 is returned, and ld_errno is set appropriately. See ldap_error(3LDAP) for a description of possible error codes. ATTRIBUTES
See attributes(5) for a description of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | |Availability |SUNWcsl (32-bit) | | |SUNWcslx (64-bit) | |Interface Stability |Evolving | +-----------------------------+-----------------------------+ SEE ALSO
ldap(3LDAP), ldap_result(3LDAP), ldap_search(3LDAP), ldap_first_attribute(3LDAP), ldap_get_values(3LDAP), ldap_get_dn(3LDAP), attributes(5) SunOS 5.10 27 Jan 2002 ldap_first_entry(3LDAP)
Man Page