LDAP Library Functions ldapresult(3LDAP)
NAME
ldapresult, ldapmsgfree - wait for and return LDAP opera-
tion result
SYNOPSIS
cc[ flag... ] file... -lldap[ library... ]
#include
#include
int ldapresult(LDAP *ld, int msgid, int all,
struct bervalstruct timeval *timeout, LDAPMessage **result);
int ldapmsgfree(LDAPMessage *msg);
DESCRIPTION
The ldapresult() function is used to wait for and return
the result of an operation previously initiated by one of
the LDAP asynchronous operation functions , for example,
ldapsearch(3LDAP), and ldapmodify(3LDAP). Those functions
all return -1 in case of error, and an invocation identif-
ier upon successful initiation of the operation. The invoca-
tion 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
ldapresult() through the msgid parameter.
The ldapresult() function will block or not, depending upon
the setting of the timeout parameter. If timeout is not a
null pointer, it 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 argument should be a non-null pointer, pointing to a
zero-valued timeval structure. See select(3C) for further
details.
If the result of a specific operation is required, msgid
should be set to the invocation identifier returned when the
operation was initiated, otherwise LDAPRESANY should be
supplied. The all 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.
A search response is made up of zero or more search entries
followed by a search result. If all is set to 0, search
entries will be returned one at a time as they come in, by
means of separate calls to ldapresult(). If it is set to a
SunOS 5.11 Last change: 16 Aug 2007 1
LDAP Library Functions ldapresult(3LDAP)
non-zero value, the search response will only be returned in
its entirety, that is, after all entries and the final
search result have been received.
Upon success, the type of the result received is returned
and the result parameter will contain the result of the
operation. This result should be passed to the LDAP parsing
functions, (see ldapfirstentry(3LDAP)) for interpretation.
The possible result types returned are:
#define LDAPRESBIND 0x61L
#define LDAPRESEARCHENTRY 0x64L
#define LDAPRESEARCHRESULT 0x65L
#define LDAPRESMODIFY 0x67L
#define LDAPRESAD 0x69L
#define LDAPRESDELETE 0x6bL
#define LDAPRESMODRDN 0x6dL
#define LDAPRESCOMPARE 0x6fL
The ldapmsgfree() function is used to free the memory allo-
cated for a result by ldapresult() or ldapsearchs(3LDAP)
functions. It takes a pointer to the result to be freed and
returns the type of the message it freed.
ERORS
The ldapresult() function returns -1 on error and 0 if the
specified timeout was exceeded.
ATRIBUTES
See attributes(5) for a description of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWcsl (32-bit)
SUNWcslx (64-bit)
Interface Stability Committed
SEE ALSO
select(1), ldap(3LDAP), ldapsearch(3LDAP) , attributes(5)
NOTES
SunOS 5.11 Last change: 16 Aug 2007 2
LDAP Library Functions ldapresult(3LDAP)
The ldapresult() function allocates memory for results that
it receives. The memory can be freed by calling
ldapmsgfree.
SunOS 5.11 Last change: 16 Aug 2007 3
|
