|
NAME | LIBRARY | SYNOPSIS | DESCRIPTION | ERRORS | SEE ALSO | ACKNOWLEDGEMENTS | COLOPHON |
LDAP_FIRST_REFERENCE(3) Library Functions Manual LDAP_FIRST_REFERENCE(3)
ldap_first_reference, ldap_next_reference, ldap_count_references -
Stepping through continuation references in a result chain
OpenLDAP LDAP (libldap, -lldap)
#include <ldap.h>
int ldap_count_references( LDAP *ld, LDAPMessage *result )
LDAPMessage *ldap_first_reference( LDAP *ld, LDAPMessage *result )
LDAPMessage *ldap_next_reference( LDAP *ld, LDAPMessage *reference )
These routines are used to step through the continuation references
in a result chain received from ldap_result(3) or the synchronous
LDAP search operation routines.
The ldap_first_reference() routine is used to retrieve the first
reference message in a result chain. It takes the result as returned
by a call to ldap_result(3), ldap_search_s(3) or ldap_search_st(3)
and returns a pointer to the first reference message in the result
chain.
This pointer should be supplied on a subsequent call to
ldap_next_reference() to get the next reference message, the result
of which should be supplied to the next call to
ldap_next_reference(), etc. ldap_next_reference() will return NULL
when there are no more reference messages. The reference messages
returned from these calls are used by ldap_parse_reference(3) to
extract referrals and controls.
A count of the number of reference messages in the search result can
be obtained by calling ldap_count_references(). It can also be used
to count the number of reference messages remaining in a result
chain.
If an error occurs in ldap_first_reference() or
ldap_next_reference(), NULL is returned. If an error occurs in
ldap_count_references(), -1 is returned.
ldap(3), ldap_result(3), ldap_search(3), ldap_parse_reference(3)
OpenLDAP Software is developed and maintained by The OpenLDAP Project
<http://www.openldap.org/>. OpenLDAP Software is derived from the
University of Michigan LDAP 3.3 Release.
This page is part of the OpenLDAP (an open source implementation of
the Lightweight Directory Access Protocol) project. Information
about the project can be found at ⟨http://www.openldap.org/⟩. If you
have a bug report for this manual page, see
⟨http://www.openldap.org/its/⟩. This page was obtained from the
project's upstream Git repository
⟨git://git.openldap.org/openldap.git⟩ on 2017-07-05. If you discover
any rendering problems in this HTML version of the page, or you
believe there is a better or more up-to-date source for the page, or
you have corrections or improvements to the information in this
COLOPHON (which is not part of the original manual page), send a mail
to man-pages@man7.org
OpenLDAP LDVERSION RELEASEDATE LDAP_FIRST_REFERENCE(3)
Pages that refer to this page: ldap_first_message(3), ldap_parse_reference(3)