2006-02-02 17:50:45 +08:00
|
|
|
.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 <ldap.h>
|
|
|
|
|
.LP
|
|
|
|
|
.ft B
|
2006-06-14 12:15:41 +08:00
|
|
|
int ldap_extended_operation(
|
|
|
|
|
.RS
|
|
|
|
|
.ft B
|
|
|
|
|
LDAP *\fIld\fB,
|
|
|
|
|
const char *\fIrequestoid\fB,
|
|
|
|
|
const struct berval *\fIrequestdata\fB,
|
|
|
|
|
LDAPControl **\fIsctrls\fB,
|
|
|
|
|
LDAPControl **\fIcctrls\fB,
|
|
|
|
|
int *\fImsgidp\fB );
|
|
|
|
|
.RE
|
2006-02-02 17:50:45 +08:00
|
|
|
.LP
|
|
|
|
|
.ft B
|
2006-06-14 12:15:41 +08:00
|
|
|
int ldap_extended_operation_s(
|
|
|
|
|
.RS
|
|
|
|
|
.ft B
|
|
|
|
|
LDAP *\fIld\fB,
|
|
|
|
|
const char *\fIrequestoid\fB,
|
|
|
|
|
const struct berval *\fIrequestdata\fB,
|
|
|
|
|
LDAPControl **\fIsctrls\fB,
|
|
|
|
|
LDAPControl **\fIcctrls\fB,
|
|
|
|
|
char **\fIretoidp\fB;
|
|
|
|
|
struct berval **\fIretdatap\fB );
|
|
|
|
|
.RE
|
2006-02-02 17:50:45 +08:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
2006-06-14 12:15:41 +08:00
|
|
|
.B ldap_extended_operation_s()
|
|
|
|
|
routine is used to synchronously perform an LDAP extended operation.
|
2006-02-02 17:50:45 +08:00
|
|
|
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
|
2006-06-14 12:15:41 +08:00
|
|
|
.B ldap_extended_operation()
|
|
|
|
|
works just like
|
|
|
|
|
.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.
|
2006-02-02 17:50:45 +08:00
|
|
|
The result of this operation can be obtained by calling
|
|
|
|
|
.BR ldap_result(3).
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR ldap_result (3),
|
|
|
|
|
.BR ldap_parse_extended_result (3)
|
|
|
|
|
.SH ACKNOWLEDGEMENTS
|
2006-06-14 12:15:41 +08:00
|
|
|
.so ../Project
|
