Movatterモバイル変換

ldap_first_reference(3) — Linux manual page

LDAP_FIRST_REFERENCE(3)  Library Functions ManualLDAP_FIRST_REFERENCE(3)

NAME        top

       ldap_first_reference, ldap_next_reference, ldap_count_references -       Stepping through continuation references in a result chain

LIBRARY        top

       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS        top

#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 )

DESCRIPTION        top

       These routines are used to step through the continuation       references in a result chain received fromldap_result(3) or the       synchronous LDAP search operation routines.       Theldap_first_reference()routine is used to retrieve the first       reference message in a result chain.  It takes theresult as       returned by a call toldap_result(3),ldap_search_s(3) orldap_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 toldap_next_reference()to get the next reference message, the       result of which should be supplied to the next call toldap_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 byldap_parse_reference(3) to extract referrals and controls.       A count of the number of reference messages in the search result       can be obtained by callingldap_count_references().  It can also       be used to count the number of reference messages remaining in a       result chain.

ERRORS        top

       If an error occurs inldap_first_reference()orldap_next_reference(), NULL is returned.  If an error occurs inldap_count_references(), -1 is returned.

SEE ALSO        top

ldap(3),ldap_result(3),ldap_search(3),ldap_parse_reference(3)

ACKNOWLEDGEMENTS        top

OpenLDAP Softwareis developed and maintained by The OpenLDAP       Project <http://www.openldap.org/>.OpenLDAP Softwareis derived       from the University of Michigan LDAP 3.3 Release.

COLOPHON        top

       This page is part of theOpenLDAP (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       ⟨https://git.openldap.org/openldap/openldap.git⟩ on 2025-08-11.       (At that time, the date of the most recent commit that was found       in the repository was 2025-08-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 isnot part of the original manual page), send a mail to       man-pages@man7.orgOpenLDAP LDVERSION             RELEASEDATELDAP_FIRST_REFERENCE(3)

Pages that refer to this page:ldap_first_message(3), ldap_parse_reference(3)

HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH.