GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LDAP_PARSE_REFERENCE (3)

NAME

ldap_parse_reference - Extract referrals and controls from a reference message

CONTENTS

Library
Synopsis
Description
Errors
See Also
Acknowledgements

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 reference 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 message. 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.

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 University of Michigan LDAP 3.3 Release.
Search for    or go to Top of page |  Section 3 |  Main Index


OpenLDAP 2.4.44 LDAP_PARSE_REFERENCE (3) 2016/02/05

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.