This commit is contained in:
Kurt Zeilenga 2006-06-14 04:15:41 +00:00
parent ad326a0192
commit 3e63cadf94

View file

@ -12,27 +12,33 @@ OpenLDAP LDAP (libldap, -lldap)
#include <ldap.h> #include <ldap.h>
.LP .LP
.ft B .ft B
int ldap_extended_operation( ld, requestoid, requestdata, sctrls[], cctrls[], msgidp ); int ldap_extended_operation(
.ft .RS
LDAP *ld; .ft B
const char *requestoid; LDAP *\fIld\fB,
const struct berval *requestdata; const char *\fIrequestoid\fB,
LDAPControl *sctrls[], *cctrls[]; const struct berval *\fIrequestdata\fB,
int *msgidp; LDAPControl **\fIsctrls\fB,
LDAPControl **\fIcctrls\fB,
int *\fImsgidp\fB );
.RE
.LP .LP
.ft B .ft B
int ldap_extended_operation_s( ld, requestoid, requestdata, sctrls[], cctrls[], retoidp, retdatap ); int ldap_extended_operation_s(
.ft .RS
LDAP *ld, .ft B
const char *requestoid; LDAP *\fIld\fB,
const struct berval *requestdata; const char *\fIrequestoid\fB,
LDAPControl *sctrls[], *cctrls[]; const struct berval *\fIrequestdata\fB,
char **retoidp; LDAPControl **\fIsctrls\fB,
struct berval **retdatap; LDAPControl **\fIcctrls\fB,
char **\fIretoidp\fB;
struct berval **\fIretdatap\fB );
.RE
.SH DESCRIPTION .SH DESCRIPTION
The The
.B ldap_extended_operation_s .B ldap_extended_operation_s()
method is used to synchronously send an extended operation to the server. routine is used to synchronously perform an LDAP extended operation.
It takes \fIrequestoid\fP, which points to a dotted OID text string identifying 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 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 operation, \fIseverctrls\fP is an array of LDAPControl structures to use with this
@ -46,19 +52,15 @@ to NULL. The memory used by this structure should be freed with the ber_bvfree
function. function.
.LP .LP
The The
.B ldap_extended_operation .B ldap_extended_operation()
works just like ldap_extended_operation_s, but the operation is asynchornous. works just like
It returns the message id of the request it initiated. .BR ldap_extended_operation_s() ,
but the operation is asynchornous. It provides the message id of
the request it initiated in the integer pointed to be \fImsgidp\fP.
The result of this operation can be obtained by calling The result of this operation can be obtained by calling
.BR ldap_result(3). .BR ldap_result(3).
.SH NOTES
The LDAP server must support the operation; otherwise an
LDAP_NOT_SUPPORTED error is returned.
.SH SEE ALSO .SH SEE ALSO
.BR ldap_result (3), .BR ldap_result (3),
.BR ldap_parse_extended_result (3) .BR ldap_parse_extended_result (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .so ../Project
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
.B OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.