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 )


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 the result as returned by a call to ldap_result(3), ldap_search_s(3) or ldap_search_st(3). In addition to ldap_parse_result(), the routines ldap_parse_sasl_bind_result() and ldap_parse_extended_result() are used to get all the result information from SASL bind and extended operations.

The errcodep 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. The matcheddnp parameter will be filled in with this string if supplied, else it will be NULL. If a string is returned, it should be freed using ldap_memfree(3).

The errmsgp parameter will be filled in with the error message field from the parsed message. This string should be freed using ldap_memfree(3).

The referralsp parameter will be filled in with an allocated array of referral strings from the parsed message. This array should be freed using ldap_memvfree(3). 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 using ldap_controls_free(3). 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.

For SASL bind results, the servercredp parameter will be filled in with an allocated berval structure containing the credentials from the server if present. The structure should be freed using ber_bvfree(3).

For extended results, the retoidp parameter will be filled in with the dotted-OID text representation of the name of the extended operation response. The string should be freed using ldap_memfree(3). If no OID was returned, *retoidp is set to NULL.

For extended results, the retdatap 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 using ber_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 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.

More Linux Commands

read_premib_configs(3) - netsnmp_config_api functions.......
The functions are a fairly extensible system of parsing various configuration files at the run time of an application. The configuration file flow is broken int

XML::XPath::Node::Comment(3pm) - an XML comment: (Manual Pages)
new ( data ) Create a new comment node. getValue / getData Returns the value in the comment toString Returns the comment with -- encoded as a numeric entity (if

write(1) - send a message to another user - Linux man page
write allows you to communicate with other users, by copying lines from your terminal to theirs. When you run the write command, the user you are writing to get

wmempcpy(3) - copy memory area (Library - Linux man page)...
The mempcpy() function is nearly identical to the memcpy(3) function. It copies n bytes from the object beginning at src into the object pointed to by dest. But

madvise1(2) - unimplemented system calls - Linux man page...
These system calls are not implemented in the Linux kernel. RETURN VALUE These system calls always return -1 and set errno to ENOSYS. NOTES Note that ftime(3),

shadow(5) - encrypted password file - Linux manual page.....
shadow contains the encrypted password information for users accounts and optional the password aging information. Included is Login name Encrypted password Day

ipcluster(1) start a cluster for IPython parallel computing
Start an IPython cluster for parallel computing. For more information on how to use ipcluster, see ipcluster --help, or ipcluster --help-all for all available c

ntfsprogs(8) - tools for doing neat things with NTFS........
ntfsprogs is a suite of NTFS utilities based around a shared library. The tools are available for free and come with full source code. TOOLS mkntfs(8) - Create

getcontext(2) - get or set the user context - Linux man page
getcontext.2 - In a System V-like environment, one has the two types mcontext_t and ucontext_t defined in &lt;ucontext.h&gt; and the four functions getcontext(), setc

utf8(7) - an ASCII compatible multibyte Unicode encoding....
The Unicode 3.0 character set occupies a 16-bit code space. The most obvious Unicode encoding (known as UCS-2) consists of a sequence of 16-bit words. Such stri

glutLayerGet(3) - retrieves GLUT state pertaining to the lay
glutLayerGet retrieves GLUT layer information for the current window represented by integers. The info parameter determines what type of layer information to re

btrfs-inspect-internal(8) resolve different btrfs items for
btrfs inspect-internal is used to resolve different items for debug purpose. SUBCOMMAND inode-resolve [-v] &lt;inode&gt; &lt;path&gt; Resolves an &lt;inode&gt; in subvolume &lt;path

We can't live, work or learn in freedom unless the software we use is free.