ldap_parse_result()

Syntax

#include <ldap.h>
int ldap_parse_result( LDAP *ld, LDAPMessage *res, 
   int *errcodep, char **matcheddnp, char **errmsgp, 
   char ***referralsp, LDAPControl ***serverctrlsp, int freeit);

Parameters

ld	Connection handle, which is a pointer to an LDAP structure containing information about the connection to the LDAP server.
res	Pointer to the LDAPMessage structure containing the results of an LDAP operation.
errcodep	Pointer to the LDAP result code specifying the result of the operation.
matcheddnp	Pointer to a string specifying the portion of a DN that finds an existing entry (in cases where the server cannot find the entry specified by a DN). See "Receiving the Portion of the DN Matching an Entry" on page 73 for details. When done, you can free this by calling the ldap_memfree() function.
errmsgp	Pointer to an additional error message string sent from the server. When done, you can free this by calling the ldap_memfree() function.
referralsp	Pointer to an array of strings representing the referrals returned by the server. When done, you can free this by calling the ldap_value_free() function.
serverctrlsp	Pointer to an array of LDAPControl structures, which represent the LDAP v3 server controls returned by the server. When done, you can free this by calling the ldap_controls_free() function.
freeit	Specifies whether or not to automatically free the results of the operation (the LDAPMessage structure specified by the res argument). The parameter can have the following possible values: 0 specifies that the result should not be freed. A non-zero value specifies that the result should be freed.

Returns

• LDAP_SUCCESS if the results were parsed successfully
• LDAP_NO_RESULTS_RETURNED if the specified LDAPMessage structure does not contain the result of an LDAP operation (for example, if it contains an entry, search reference, or chain of search results instead of the result of an LDAP operation).
• LDAP_MORE_RESULTS_TO_RETURN if the result in the LDAPMessage structure is part of a chain of results and the last result is not included.
• LDAP_DECODING_ERROR if an error occurred when decoding the BER-encoded message.
• LDAP_PARAM_ERROR if an invalid parameter was passed to the function
• LDAP_NO_MEMORY if memory cannot be allocated.

Description

• the LDAP result code that indicates the result of the LDAP operation (errcodep)
• an additional error message (optional) sent by the server (errmsgp)
• the portion of the DN that finds an entry, if the server is unable to find an entry from a DN that you specify (matcheddnp) (see "Receiving the Portion of the DN Matching an Entry" on page 73 for details)
• a set of referrals, if the server does not contain the entries that you've specified and if the server is configured to refer clients to other servers (referralsp)
• a set of server response controls that are relevant to the operation (serverctrlsp)

• If the result is an entry returned as a search result, call the ldap_first_entry() function to retrieve the entry.
• If the result is a search reference, call the ldap_parse_reference() function to retrieve the reference.

Example

• For an example of parsing the results of an asynchronous LDAP add operation, see "Example: Adding an Entry to the Directory (Asynchronous)" on page 182.
• For an example of parsing the results of an asynchronous LDAP modify operation, see "Example: Modifying an Entry in the Directory (Asynchronous)" on page 201.
• For an example of parsing the results of an asynchronous LDAP delete operation, see "Example: Deleting an Entry from the Directory (Asynchronous)" on page 213.
• For an example of parsing the results of an asynchronous LDAP modify DN operation, see "Example: Renaming an Entry in the Directory (Asynchronous)" on page 225.
• For an example of parsing the results of an asynchronous LDAP search operation, see "Example: Searching the Directory (Asynchronous)" on page 140.
• For an example of parsing the results of an asynchronous LDAP bind operation, see "Performing an Asynchronous Authentication Operation" on page 60.

See Also

Last Updated: 10/01/98 17:06:23