ldap_result()

Syntax

#include <ldap.h>
int ldap_result( LDAP *ld, int msgid, int all, 
   struct timeval *timeout, LDAPMessage **result );

Parameters

ld	Connection handle, which is a pointer to an LDAP structure containing information about the connection to the LDAP server.
msgid	Message ID of the operation for which you want the results. To check any operation, pass LDAP_RES_ANY as the value of this parameter.
all	Specifies how the results of a search are returned. This parameter can have the following values: 0 specifies that the results are returned one entry at a time, using separate calls to ldap_result(). A non-zero value specifies that all results are returned at the same time (after the final search result is obtained by the library).
timeout	Specifies a maximum interval to wait for the selection to complete. If timeout is a NULL pointer, the select blocks indefinitely. To effect a poll, the timeout parameter should be a non-NULL pointer, pointing to a zero-valued timeval structure.
result	Result of the operation. To interpret the results, pass this to the LDAP parsing routines, such as ldap_result2error(), ldap_parse_result(), and ldap_first_entry().

Returns

• LDAP_RES_BIND indicates that the LDAPMessage structure contains the result of an LDAP bind operation.
• LDAP_RES_SEARCH_ENTRY indicates that the LDAPMessage structure contains an entry found during an LDAP search operation.
• LDAP_RES_SEARCH_REFERENCE indicates that the LDAPMessage structure contains an LDAP v3 search reference (a referral to another LDAP server) found during an LDAP search operation.
• LDAP_RES_SEARCH_RESULT indicates that the LDAPMessage structure contains the result of an LDAP search operation.
• LDAP_RES_MODIFY indicates that the LDAPMessage structure contains the result of an LDAP modify operation.
• LDAP_RES_ADD indicates that the LDAPMessage structure contains the result of an LDAP add operation.
• LDAP_RES_DELETE indicates that the LDAPMessage structure contains the result of an LDAP delete operation.
• LDAP_RES_MODDN or LDAP_RES_RENAME indicates that the LDAPMessage structure contains the result of an LDAP modify DN operation.
• LDAP_RES_COMPARE indicates that the LDAPMessage structure contains the result of an LDAP compare operation.
• LDAP_RES_EXTENDED indicates that the LDAPMessage structure contains the result of an LDAP v3 extended operation.
• -1 indicates that an error occurred. The error code is set in the LDAP structure. To get the error code, call the ldap_get_lderrno() function. (See "Result Codes" on page 691 for a complete listing of error codes.)
• 0 indicates that the operation has timed out.

Example

• For an example of getting the results of an asynchronous LDAP add operation, see "Example: Adding an Entry to the Directory (Asynchronous)" on page 182.
• For an example of getting the results of an asynchronous LDAP modify operation, see "Example: Modifying an Entry in the Directory (Asynchronous)" on page 201.
• For an example of getting the results of an asynchronous LDAP delete operation, see "Example: Deleting an Entry from the Directory (Asynchronous)" on page 213.
• For an example of getting 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 getting the results of an asynchronous LDAP search operation, see "Example: Searching the Directory (Asynchronous)" on page 140.
• For an example of getting 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