git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_result.3

   1 .TH LDAP_RESULT 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_result \- Wait for the result of an LDAP operation
   7 .SH LIBRARY
   8 OpenLDAP LDAP (libldap, -lldap)
   9 .SH SYNOPSIS
  10 .nf
  11 .ft B
  12 #include <ldap.h>
  13 .LP
  14 .ft B
  15 int ldap_result( LDAP *ld, int msgid, int all,
  16         struct timeval *timeout, LDAPMessage **result );
  17
  18 int ldap_msgfree( LDAPMessage *msg );
  19
  20 int ldap_msgtype( LDAPMessage *msg );
  21
  22 int ldap_msgid( LDAPMessage *msg );
  23 .ft
  24 .SH DESCRIPTION
  25 The
  26 .B ldap_result()
  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.,
  30 .BR ldap_search (3),
  31 .BR ldap_modify (3),
  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
  37 .B ldap_result()
  38 through the \fImsgid\fP parameter.
  39 .LP
  40 The
  41 .B ldap_result()
  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
  49 .BR select (2)
  50 for further details.
  51 .LP
  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.
  56 .LP
  57 The \fIall\fP parameter, if non-zero, causes
  58 .B ldap_result()
  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.
  62 .LP
  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
  68 .BR ldap_result() .
  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.
  73 .LP
  74 Upon success, the type of the result received is returned and the
  75 \fIresult\fP parameter will contain the result of the operation.  This
  76 result should be passed to the LDAP parsing routines,
  77 .BR ldap_first_message (3)
  78 and friends, for interpretation.
  79 .LP
  80 The possible result types returned are:
  81 .LP
  82 .nf
  83         LDAP_RES_BIND (0x61)
  84         LDAP_RES_SEARCH_ENTRY (0x64)
  85         LDAP_RES_SEARCH_REFERENCE (0x73)
  86         LDAP_RES_SEARCH_RESULT (0x65)
  87         LDAP_RES_MODIFY (0x67)
  88         LDAP_RES_ADD (0x69)
  89         LDAP_RES_DELETE (0x6b)
  90         LDAP_RES_MODDN (0x6d)
  91         LDAP_RES_COMPARE (0x6f)
  92         LDAP_RES_EXTENDED (0x78)
  93         LDAP_RES_INTERMEDIATE (0x79)
  94 .fi
  95 .LP
  96 The
  97 .B ldap_msgfree()
  98 routine is used to free the memory allocated for
  99 result(s) by
 100 .B ldap_result()
 101 or
 102 .BR ldap_search_s (3)
 103 and friends.
 104 It takes a pointer to the result or result chain to be freed and returns
 105 the type of the last message in the chain.
 106 If the parameter is NULL, the function does nothing and returns zero.
 107 .LP
 108 The
 109 .B ldap_msgtype()
 110 routine returns the type of a message.
 111 .LP
 112 The
 113 .B ldap_msgid()
 114 routine returns the message id of a message.
 115 .SH ERRORS
 116 .B ldap_result()
 117 returns -1 if something bad happens, and zero if the
 118 timeout specified was exceeded.
 119 .B ldap_msgtype()
 120 and
 121 .B ldap_msgid()
 122 return -1 on error.
 123 .SH SEE ALSO
 124 .BR ldap (3),
 125 .BR ldap_search (3),
 126 .BR ldap_first_message (3),
 127 .BR select (2)
 128 .SH ACKNOWLEDGEMENTS
 129 .B OpenLDAP
 130 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 131 .B OpenLDAP
 132 is derived from University of Michigan LDAP 3.3 Release.