upstream/openldap
1
0
Fork 0
mirror of https://git.openldap.org/openldap/openldap.git synced 2025-12-24 00:29:35 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Misc. IETF LDAPext updates

Browse source
This commit is contained in:
Kurt Zeilenga 2001-09-27 02:39:52 +00:00
parent 2a853f0ca5
commit ddc6c016b0
1 changed files with 36 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
doc/man/man3/ldap_result.3
View file

@ -10,27 +10,15 @@ ldap_result \- Wait for the result of an LDAP operation
#include <ldap.h>
.LP
.ft B
int ldap_result(ld, msgid, all, timeout, result)
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 );
.ft
LDAP *ld;
int msgid, all;
struct timeval *timeout;
LDAPMessage **result;
.LP
.ft B
int ldap_msgfree(msg)
.ft
LDAPMessage *msg;
.LP
.ft B
int ldap_msgtype(msg)
.ft
LDAPMessage *msg;
.LP
.ft B
int ldap_msgid(msg)
.ft
LDAPMessage *msg;
.SH DESCRIPTION
The
.B ldap_result()
@ -61,37 +49,46 @@ 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
initiated, otherwise LDAP_RES_ANY should be supplied. The \fIall\fP
parameter only has meaning for search responses and is used to select
whether a single entry of the search response should be returned, or
all results of the search should be returned.
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.
.LP
A search response is made up of zero or
more search entries followed by a search result. If \fIall\fP is set
to 0, search entries will be returned one at a time as they come in,
via separate calls to
more search entries, zero or more search references, and zero or
more extended parital responses followed by a search result. If
\fIall\fP is set to 0, search entries will be returned one at a
time as they come in, via separate calls to
.BR ldap_result() .
If it's set to 1, the search
response will only be returned in its entirety, i.e., after all entries
and the final search result have been received.
response will only be returned in its entirety, i.e., after all entries,
all references, all extended parital responses, and the final search
result have been received.
.LP
Upon success, the type of the result received is returned and the
\fIresult\fP parameter will contain the result of the operation. This
result should be passed to the LDAP parsing routines,
.BR ldap_first_entry (3)
.BR ldap_first_message (3)
and friends, for interpretation.
.LP
The possible result types returned are:
.LP
.nf
#define LDAP_RES_BIND 0x61L
#define LDAP_RES_SEARCH_ENTRY 0x64L
#define LDAP_RES_SEARCH_RESULT 0x65L
#define LDAP_RES_MODIFY 0x67L
#define LDAP_RES_ADD 0x69L
#define LDAP_RES_DELETE 0x6bL
#define LDAP_RES_MODRDN 0x6dL
#define LDAP_RES_COMPARE 0x6fL
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)
.fi
.LP
The
@ -120,13 +117,10 @@ timeout specified was exceeded.
and
.B ldap_msgid()
return -1 on error.
.SH NOTES
This routine dynamically allocates memory for results that it receives.
The memory can be freed by the caller using
.BR ldap_msgfree .
.SH SEE ALSO
.BR ldap (3),
.BR ldap_search (3),
.BR ldap_first_message (3),
.BR select (2)
.SH ACKNOWLEDGEMENTS
.B OpenLDAP