ldap_get_entry_controls(3ldap) [opensolaris man page]

ldap_get_entry_controls(3LDAP)				      LDAP Library Functions				    ldap_get_entry_controls(3LDAP)

NAME

       ldap_get_entry_controls - get the LDAP controls included with a directory entry in a set of search results

SYNOPSIS

       cc-flag ... file...-lldap [ -library ... ]
       #include <ldap.h>

       int ldap_get_entry_controls(LDAP *ld, LDAPMessage *entry,
	    LDAPControl ***serverctrlsp

DESCRIPTION

       The  ldap_get_entry_controls() function retrieves the LDAP v3 controls included in a directory entry in a chain of search results. The LDAP
       controls are specified in an array of LDAPControl structures. Each LDAPControl structure represents an LDAP  control.  The  function  takes
       entry as a parameter, which points to an LDAPMessage structure that represents an entry in a chain of search results.

       The  entry  notification  controls  that  are  used with persistent search controls are the only controls that are returned with individual
       entries. Other controls are returned with results sent from the server. You can call ldap_parse_result() to retrieve those controls.

ERRORS

       ldap_get_entry_controls() returns the following error codes.

       LDAP_SUCCESS	      LDAP controls were successfully retrieved.

       LDAP_DECODING_ERROR    An error occurred when decoding the BER-encoded message.

       LDAP_PARAM_ERROR       An invalid parameter was passed to the function.

       LDAP_NO_MEMORY	      Memory cannot be allocated.

ATTRIBUTES

       See attributes(5)  for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWcsl (32-bit)		   |
       +-----------------------------+-----------------------------+
       |			     |SUNWcslx (64-bit) 	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Evolving			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       ldap_error(3LDAP), ldap_parse_result(3LDAP), attributes(5)

SunOS 5.11							    6 Jan 2003					    ldap_get_entry_controls(3LDAP)

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.11							    27 Jan 2002 					   ldap_first_entry(3LDAP)