1 .TH LDAP_RESULT 3 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldap_result \- Wait for the result of an LDAP operation
8 OpenLDAP LDAP (libldap, -lldap)
15 int ldap_result( LDAP *ld, int msgid, int all,
16 struct timeval *timeout, LDAPMessage **result );
18 int ldap_msgfree( LDAPMessage *msg );
20 int ldap_msgtype( LDAPMessage *msg );
22 int ldap_msgid( LDAPMessage *msg );
27 routine is used to wait for and return the result of
28 an operation previously initiated by one of the LDAP asynchronous
29 operation routines (e.g.,
32 etc.). Those routines all return -1 in case of error, and an
33 invocation identifier upon successful initiation of the operation. The
34 invocation identifier is picked by the library and is guaranteed to be
35 unique across the LDAP session. It can be used to request the result
36 of a specific operation from
38 through the \fImsgid\fP parameter.
42 routine will block or not, depending upon the setting
43 of the \fItimeout\fP parameter.
44 If timeout is not a NULL pointer, it specifies a maximum
45 interval to wait for the selection to complete. If timeout
46 is a NULL pointer, the select blocks indefinitely. To
47 effect a poll, the timeout argument should be a non-NULL
48 pointer, pointing to a zero-valued timeval structure. See
52 If the result of a specific operation is required, \fImsgid\fP should
53 be set to the invocation identifier returned when the operation was
54 initiated, otherwise LDAP_RES_ANY or LDAP_RES_UNSOLICITED should be
55 supplied to wait for any or unsolicited response.
57 The \fIall\fP parameter, if non-zero, causes
59 to return all responses with msgid, otherwise only the
60 next response is returned. This is commonly used to obtain all
61 the responses of a search operation.
63 A search response is made up of zero or
64 more search entries, zero or more search references, and zero or
65 more extended partial responses followed by a search result. If
66 \fIall\fP is set to 0, search entries will be returned one at a
67 time as they come in, via separate calls to
69 If it's set to 1, the search
70 response will only be returned in its entirety, i.e., after all entries,
71 all references, all extended partial responses, and the final search
72 result have been received.
74 Upon success, the type of the result received is returned and the
75 \fIresult\fP parameter will contain the result of the operation;
76 otherwise, the \fIresult\fP parameter is undefined. This
77 result should be passed to the LDAP parsing routines,
78 .BR ldap_first_message (3)
79 and friends, for interpretation.
81 The possible result types returned are:
85 LDAP_RES_SEARCH_ENTRY (0x64)
86 LDAP_RES_SEARCH_REFERENCE (0x73)
87 LDAP_RES_SEARCH_RESULT (0x65)
88 LDAP_RES_MODIFY (0x67)
90 LDAP_RES_DELETE (0x6b)
92 LDAP_RES_COMPARE (0x6f)
93 LDAP_RES_EXTENDED (0x78)
94 LDAP_RES_EXTENDED_PARTIAL (0x79)
99 routine is used to free the memory allocated for
103 .BR ldap_search_s (3)
105 It takes a pointer to the result or result chain to be freed and returns
106 the type of the last message in the chain.
107 If the parameter is NULL, the function does nothing and returns zero.
111 routine returns the type of a message.
115 routine returns the message id of a message.
118 returns -1 if something bad happens, and zero if the
119 timeout specified was exceeded.
127 .BR ldap_first_message (3),
131 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
133 is derived from University of Michigan LDAP 3.3 Release.