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

   1 .TH LDAP_EXTENDED_OPERATION 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_extended_operation, ldap_extended_operation_s \- Extends the LDAP operations to the LDAP server.
   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_extended_operation( ld, requestoid, requestdata, sctrls[], cctrls[], msgidp );
  16 .ft
  17 LDAP *ld;
  18 const char *requestoid;
  19 const struct berval *requestdata;
  20 LDAPControl *sctrls[], *cctrls[];
  21 int *msgidp;
  22 .LP
  23 .ft B
  24 int ldap_extended_operation_s( ld, requestoid, requestdata, sctrls[], cctrls[], retoidp, retdatap );
  25 .ft
  26 LDAP *ld,
  27 const char *requestoid;
  28 const struct berval *requestdata;
  29 LDAPControl *sctrls[], *cctrls[];
  30 char **retoidp;
  31 struct berval **retdatap;
  32 .SH DESCRIPTION
  33 The
  34 .B ldap_extended_operation_s
  35 method is used to synchronously send an extended operation to the server.
  36 It takes \fIrequestoid\fP, which points to a dotted OID text string identifying
  37 the extended operation to perform. \fIrequestdata\fP is the data required for the
  38 operation, \fIseverctrls\fP is an array of LDAPControl structures to use with this
  39 extended operation,\fIclientctrls\fP is an array of LDAPControl structures that list
  40 the client controls to use with this extended operation .The input parameter
  41 \fIretoidp\fP points to a dotted-OID text string returned by the LDAP server.
  42 The memory used by the string should be freed with the ldap_memfree function.
  43 retdatap is an output parameter which points to a pointer to a berval structure
  44 that contains the returned data. If no data is returned, the server set this
  45 to NULL. The memory used by this structure should be freed with the ber_bvfree
  46 function.
  47 .LP
  48 The
  49 .B ldap_extended_operation
  50 works just like ldap_extended_operation_s, but the operation is asynchornous.
  51 It returns the message id of the request it initiated.
  52 The result of this operation can be obtained by calling
  53 .BR ldap_result(3).
  54 .SH NOTES
  55 The LDAP server must support the operation; otherwise an
  56 LDAP_NOT_SUPPORTED error is returned.
  57 .SH SEE ALSO
  58 .BR ldap_result (3),
  59 .BR ldap_parse_extended_result (3)
  60 .SH ACKNOWLEDGEMENTS
  61 .B OpenLDAP
  62 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  63 .B OpenLDAP
  64 is derived from University of Michigan LDAP 3.3 Release.