ldap_result.3 3.99 KB
Newer Older
1
.TH LDAP_RESULT 3 "RELEASEDATE" "OpenLDAP LDVERSION"
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
.\" $OpenLDAP$
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3
.\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
4
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
5
6
.SH NAME
ldap_result \- Wait for the result of an LDAP operation
7
.SH LIBRARY
Kurt Zeilenga's avatar
Kurt Zeilenga committed
8
OpenLDAP LDAP (libldap, -lldap)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
9
10
11
12
13
14
.SH SYNOPSIS
.nf
.ft B
#include <ldap.h>
.LP
.ft B
Kurt Zeilenga's avatar
Kurt Zeilenga committed
15
16
17
18
19
20
21
22
int ldap_result( LDAP *ld, int msgid, int all,
	struct timeval *timeout, LDAPMessage **result );

int ldap_msgfree( LDAPMessage *msg );

int ldap_msgtype( LDAPMessage *msg );

int ldap_msgid( LDAPMessage *msg );
Kurt Zeilenga's avatar
Kurt Zeilenga committed
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
.ft
.SH DESCRIPTION
The
.B ldap_result()
routine is used to wait for and return the result of
an operation previously initiated by one of the LDAP asynchronous
operation routines (e.g.,
.BR ldap_search (3),
.BR ldap_modify (3),
etc.).  Those routines all return -1 in case of error, and an
invocation identifier upon successful initiation of the operation. The
invocation identifier is picked by the library and is guaranteed to be
unique across the LDAP session.  It can be used to request the result
of a specific operation from
.B ldap_result()
through the \fImsgid\fP parameter.
.LP
The
.B ldap_result()
routine will block or not, depending upon the setting
of the \fItimeout\fP parameter.
If timeout is not a NULL pointer,  it  specifies  a  maximum
interval  to wait for the selection to complete.  If timeout
46
47
48
49
is a NULL  pointer, the LDAP_OPT_TIMEOUT value set by
.BR ldap_set_option (3)
is used. With the default setting,
the  select  blocks  indefinitely.   To
Kurt Zeilenga's avatar
Kurt Zeilenga committed
50
51
52
53
54
55
56
effect  a  poll,  the  timeout argument should be a non-NULL
pointer, pointing to a zero-valued timeval structure.  See
.BR select (2)
for further details.
.LP
If the result of a specific operation is required, \fImsgid\fP should
be set to the invocation identifier returned when the operation was
Kurt Zeilenga's avatar
Kurt Zeilenga committed
57
58
59
60
61
62
63
64
initiated, otherwise LDAP_RES_ANY or LDAP_RES_UNSOLICITED should be
supplied to wait for any or unsolicited response.
.LP
The \fIall\fP parameter, if non-zero, causes
.B ldap_result()
to return all responses with msgid, otherwise only the
next response is returned.  This is commonly used to obtain all
the responses of a search operation.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
65
66
.LP
A search response is made up of zero or
Kurt Zeilenga's avatar
Kurt Zeilenga committed
67
more search entries, zero or more search references, and zero or
Hallvard Furuseth's avatar
Hallvard Furuseth committed
68
more extended partial responses followed by a search result.  If
Kurt Zeilenga's avatar
Kurt Zeilenga committed
69
70
\fIall\fP is set to 0, search entries will be returned one at a
time as they come in, via separate calls to
Kurt Zeilenga's avatar
Kurt Zeilenga committed
71
72
.BR ldap_result() .
If it's set to 1, the search
Kurt Zeilenga's avatar
Kurt Zeilenga committed
73
response will only be returned in its entirety, i.e., after all entries,
Hallvard Furuseth's avatar
Hallvard Furuseth committed
74
all references, all extended partial responses, and the final search
Kurt Zeilenga's avatar
Kurt Zeilenga committed
75
result have been received.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
76
77
.LP
Upon success, the type of the result received is returned and the
78
79
\fIresult\fP parameter will contain the result of the operation;
otherwise, the \fIresult\fP parameter is undefined.  This
Kurt Zeilenga's avatar
Kurt Zeilenga committed
80
result should be passed to the LDAP parsing routines,
Kurt Zeilenga's avatar
Kurt Zeilenga committed
81
.BR ldap_first_message (3)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
82
83
84
85
86
and friends, for interpretation.
.LP
The possible result types returned are:
.LP
.nf
Kurt Zeilenga's avatar
Kurt Zeilenga committed
87
88
89
90
91
92
93
94
95
96
97
	LDAP_RES_BIND (0x61)
	LDAP_RES_SEARCH_ENTRY (0x64)
	LDAP_RES_SEARCH_REFERENCE (0x73)
	LDAP_RES_SEARCH_RESULT (0x65)
	LDAP_RES_MODIFY (0x67)
	LDAP_RES_ADD (0x69)
	LDAP_RES_DELETE (0x6b)
	LDAP_RES_MODDN (0x6d)
	LDAP_RES_COMPARE (0x6f)
	LDAP_RES_EXTENDED (0x78)
	LDAP_RES_EXTENDED_PARTIAL (0x79)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
98
99
100
101
102
.fi
.LP
The
.B ldap_msgfree()
routine is used to free the memory allocated for
103
result(s) by
Kurt Zeilenga's avatar
Kurt Zeilenga committed
104
105
106
.B ldap_result()
or
.BR ldap_search_s (3)
107
108
109
110
and friends.
It takes a pointer to the result or result chain to be freed and returns
the type of the last message in the chain.
If the parameter is NULL, the function does nothing and returns zero.
111
112
113
114
115
116
117
118
.LP
The
.B ldap_msgtype()
routine returns the type of a message.
.LP
The
.B ldap_msgid()
routine returns the message id of a message.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
119
120
121
122
.SH ERRORS
.B ldap_result()
returns -1 if something bad happens, and zero if the
timeout specified was exceeded.
123
124
125
126
.B ldap_msgtype()
and
.B ldap_msgid()
return -1 on error.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
127
128
129
.SH SEE ALSO
.BR ldap (3),
.BR ldap_search (3),
Kurt Zeilenga's avatar
Kurt Zeilenga committed
130
.BR ldap_first_message (3),
Kurt Zeilenga's avatar
Kurt Zeilenga committed
131
.BR select (2)
Kurt Zeilenga's avatar
Kurt Zeilenga committed
132
.SH ACKNOWLEDGEMENTS
Kurt Zeilenga's avatar
Kurt Zeilenga committed
133
.so ../Project