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. |  |
NAME |LIBRARY |SYNOPSIS |DESCRIPTION |ERRORS |SEE ALSO |ACKNOWLEDGEMENTS |COLOPHON | |
LDAP_PARSE_RESULT(3) Library Functions ManualLDAP_PARSE_RESULT(3)ldap_parse_result - Parsing results
OpenLDAP LDAP (libldap, -lldap)
#include <ldap.h>int ldap_parse_result( LDAP *ld, LDAPMessage *result,int *errcodep, char **matcheddnp, char **errmsgp,char ***referralsp, LDAPControl ***serverctrlsp,int freeit )int ldap_parse_sasl_bind_result( LDAP *ld, LDAPMessage *result,struct berval **servercredp, int freeit )int ldap_parse_extended_result( LDAP *ld, LDAPMessage *result,char **retoidp, struct berval **retdatap, int freeit )int ldap_parse_intermediate( LDAP *ld, LDAPMessage *result,char **retoidp, struct berval **retdatap,LDAPControl ***serverctrlsp, int freeit )
These routines are used to extract information from a result message. They will operate on the first result message in a chain of search results (skipping past other message types). They take theresult as returned by a call toldap_result(3),ldap_search_s(3) orldap_search_st(3). In addition toldap_parse_result(), the routinesldap_parse_sasl_bind_result() andldap_parse_extended_result()are used to get all the result information from SASL bind and extended operations. To extract information from intermediate responses,ldap_parse_intermediate() can be used. Theerrcodep parameter will be filled in with the result code from the result message. The server might supply a matched DN string in the message indicating how much of a name in a request was recognized. Thematcheddnp parameter will be filled in with this string if supplied, else it will be NULL. If a string is returned, it should be freed usingldap_memfree(3). Theerrmsgp parameter will be filled in with the error message field from the parsed message. This string should be freed usingldap_memfree(3). Thereferralsp parameter will be filled in with an allocated array of referral strings from the parsed message. This array should be freed usingldap_memvfree(3). If no referrals were returned,*referralsp is set to NULL. Theserverctrlsp parameter will be filled in with an allocated array of controls copied from the parsed message. The array should be freed usingldap_controls_free(3). If no controls were returned,*serverctrlsp is set to NULL. Thefreeit parameter determines whether the parsed message is freed or not after the extraction. Any non-zero value will make it free the message. Theldap_msgfree(3) routine can also be used to free the message later. For SASL bind results, theservercredp parameter will be filled in with an allocated berval structure containing the credentials from the server if present. The structure should be freed usingber_bvfree(3). For extended results and intermediate responses, theretoidp parameter will be filled in with the dotted-OID text representation of the name of the extended operation response. The string should be freed usingldap_memfree(3). If no OID was returned,*retoidp is set to NULL. For extended results and intermediate responses, theretdatap parameter will be filled in with a pointer to a berval structure containing the data from the extended operation response. The structure should be freed usingber_bvfree(3). If no data were returned,*retdatap is set to NULL. For all the above result parameters, NULL values can be used in calls in order to ignore certain fields.
Upon success LDAP_SUCCESS is returned. Otherwise the values of the result parameters are undefined.
ldap(3),ldap_result(3),ldap_search(3),ldap_memfree(3),ldap_memvfree(3),ldap_get_values(3),ldap_controls_free(3),lber-types(3)
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.
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_PARSE_RESULT(3)Pages that refer to this page:ldap(3), ldap_extended_operation(3), ldap_first_message(3), ldap_sync(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. | |