ldap_parse_reference - Extract referrals and controls from a reference message
#include <ldap.h> int ldap_parse_reference( LDAP *ld, LDAPMessage *reference, char ***referralsp, LDAPControl ***serverctrlsp, int freeit )
LDAP_PARSE_REFERENCE(3oldap)
NAME
ldap_parse_reference - Extract referrals and controls from a reference
message
LIBRARY
OpenLDAP LDAP (libldap, -lldap)
SYNOPSIS
#include <ldap.h>
int ldap_parse_reference( LDAP *ld, LDAPMessage *reference,
char ***referralsp, LDAPControl ***serverctrlsp,
int freeit )
DESCRIPTION
The ldap_parse_reference() routine is used to extract referrals and
controls from a reference message. The reference parameter is a refer-
ence message as returned by a call to ldap_first_reference(3),
ldap_next_reference(3), ldap_first_message(3), ldap_next_message(3), or
ldap_result(3).
The referralsp parameter will be filled in with an allocated array of
character strings. The strings are copies of the referrals contained in
the parsed message. The array should be freed by calling
ldap_value_free(3). If referralsp is NULL, no referrals are returned.
If no referrals were returned, *referralsp is set to NULL.
The serverctrlsp parameter will be filled in with an allocated array of
controls copied from the parsed message. The array should be freed by
calling ldap_controls_free(3). If serverctrlsp is NULL, no controls
are returned. If no controls were returned, *serverctrlsp is set to
NULL.
The freeit parameter determines whether the parsed message is freed or
not after the extraction. Any non-zero value will make it free the mes-
sage. The ldap_msgfree(3) routine can also be used to free the message
later.
ERRORS
Upon success LDAP_SUCCESS is returned. Otherwise the values of the
referralsp and serverctrlsp parameters are undefined.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------------------+
|Availability | system/network/ldap/openldap |
+---------------+------------------------------+
|Stability | Pass-through uncommitted |
+---------------+------------------------------+
SEE ALSO
ldap(3), ldap_first_reference(3), ldap_first_message(3),
ldap_result(3), ldap_get_values(3), ldap_controls_free(3)
ACKNOWLEDGEMENTS
OpenLDAP Software is developed and maintained by The OpenLDAP Project
<http://www.openldap.org/>. OpenLDAP Software is derived from the Uni-
versity of Michigan LDAP 3.3 Release.
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from ftp://ftp.openldap.org/pub/OpenLDAP/openl-
dap-release/openldap-2.4.59.tgz.
Further information about this software can be found on the open source
community website at http://www.openldap.org/.
OpenLDAP 2.4.59 2021/06/03
LDAP_PARSE_REFERENCE(3oldap)