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(
  16 .RS
  17 .ft B
  18 LDAP *\fIld\fB,
  19 const char *\fIrequestoid\fB,
  20 const struct berval *\fIrequestdata\fB,
  21 LDAPControl **\fIsctrls\fB,
  22 LDAPControl **\fIcctrls\fB,
  23 int *\fImsgidp\fB );
  24 .RE
  25 .LP
  26 .ft B
  27 int ldap_extended_operation_s(
  28 .RS
  29 .ft B
  30 LDAP *\fIld\fB,
  31 const char *\fIrequestoid\fB,
  32 const struct berval *\fIrequestdata\fB,
  33 LDAPControl **\fIsctrls\fB,
  34 LDAPControl **\fIcctrls\fB,
  35 char **\fIretoidp\fB;
  36 struct berval **\fIretdatap\fB );
  37 .RE
  38 .SH DESCRIPTION
  39 The
  40 .B ldap_extended_operation_s()
  41 routine is used to synchronously perform an LDAP extended operation.
  42 It takes \fIrequestoid\fP, which points to a dotted OID text string identifying
  43 the extended operation to perform. \fIrequestdata\fP is the data required for the
  44 operation, \fIseverctrls\fP is an array of LDAPControl structures to use with this
  45 extended operation,\fIclientctrls\fP is an array of LDAPControl structures that list
  46 the client controls to use with this extended operation .The input parameter
  47 \fIretoidp\fP points to a dotted-OID text string returned by the LDAP server.
  48 The memory used by the string should be freed with the ldap_memfree function.
  49 retdatap is an output parameter which points to a pointer to a berval structure
  50 that contains the returned data. If no data is returned, the server set this
  51 to NULL. The memory used by this structure should be freed with the ber_bvfree
  52 function.
  53 .LP
  54 The
  55 .B ldap_extended_operation()
  56 works just like
  57 .BR ldap_extended_operation_s() ,
  58 but the operation is asynchornous.  It provides the message id of
  59 the request it initiated in the integer pointed to be \fImsgidp\fP.
  60 The result of this operation can be obtained by calling
  61 .BR ldap_result(3).
  62 .SH SEE ALSO
  63 .BR ldap_result (3),
  64 .BR ldap_parse_extended_result (3)
  65 .SH ACKNOWLEDGEMENTS
  66 .so ../Project