From 74d54b121a386cce9eb9f45418c3ad9749cdbf7a Mon Sep 17 00:00:00 2001 From: Anil Kumar Kommuri Date: Thu, 2 Feb 2006 09:50:45 +0000 Subject: [PATCH] Added new files for ldap_extended_operation() API --- doc/man/man3/ldap_extended_operation.3 | 64 ++++++++++++++++++++ doc/man/man3/ldap_extended_operation.3.links | 2 + 2 files changed, 66 insertions(+) create mode 100644 doc/man/man3/ldap_extended_operation.3 create mode 100644 doc/man/man3/ldap_extended_operation.3.links diff --git a/doc/man/man3/ldap_extended_operation.3 b/doc/man/man3/ldap_extended_operation.3 new file mode 100644 index 0000000000..2c9e31037d --- /dev/null +++ b/doc/man/man3/ldap_extended_operation.3 @@ -0,0 +1,64 @@ +.TH LDAP_EXTENDED_OPERATION 3 "RELEASEDATE" "OpenLDAP LDVERSION" +.\" $OpenLDAP$ +.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved. +.\" Copying restrictions apply. See COPYRIGHT/LICENSE. +.SH NAME +ldap_extended_operation, ldap_extended_operation_s \- Extends the LDAP operations to the LDAP server. +.SH LIBRARY +OpenLDAP LDAP (libldap, -lldap) +.SH SYNOPSIS +.nf +.ft B +#include +.LP +.ft B +int ldap_extended_operation( ld, requestoid, requestdata, sctrls[], cctrls[], msgidp ); +.ft +LDAP *ld; +const char *requestoid; +const struct berval *requestdata; +LDAPControl *sctrls[], *cctrls[]; +int *msgidp; +.LP +.ft B +int ldap_extended_operation_s( ld, requestoid, requestdata, sctrls[], cctrls[], retoidp, retdatap ); +.ft +LDAP *ld, +const char *requestoid; +const struct berval *requestdata; +LDAPControl *sctrls[], *cctrls[]; +char **retoidp; +struct berval **retdatap; +.SH DESCRIPTION +The +.B ldap_extended_operation_s +method is used to synchronously send an extended operation to the server. +It takes \fIrequestoid\fP, which points to a dotted OID text string identifying +the extended operation to perform. \fIrequestdata\fP is the data required for the +operation, \fIseverctrls\fP is an array of LDAPControl structures to use with this +extended operation,\fIclientctrls\fP is an array of LDAPControl structures that list +the client controls to use with this extended operation .The input parameter +\fIretoidp\fP points to a dotted-OID text string returned by the LDAP server. +The memory used by the string should be freed with the ldap_memfree function. +retdatap is an output parameter which points to a pointer to a berval structure +that contains the returned data. If no data is returned, the server set this +to NULL. The memory used by this structure should be freed with the ber_bvfree +function. +.LP +The +.B ldap_extended_operation +works just like ldap_extended_operation_s, but the operation is asynchornous. +It returns the message id of the request it initiated. +The result of this operation can be obtained by calling +.BR ldap_result(3). +.SH NOTES +The LDAP server must support the operation; otherwise an +LDAP_NOT_SUPPORTED error is returned. +.SH SEE ALSO +.BR ldap_result (3), +.BR ldap_parse_extended_result (3) +.SH ACKNOWLEDGEMENTS +.B OpenLDAP +is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). +.B OpenLDAP +is derived from University of Michigan LDAP 3.3 Release. diff --git a/doc/man/man3/ldap_extended_operation.3.links b/doc/man/man3/ldap_extended_operation.3.links new file mode 100644 index 0000000000..1c5dc679e3 --- /dev/null +++ b/doc/man/man3/ldap_extended_operation.3.links @@ -0,0 +1,2 @@ +ldap_extended_operation_s.3 + -- 2.39.5