X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Fman%2Fman3%2Fldap_extended_operation.3;h=053eb1cf9a19e999eed0a5525f0643bee102cc07;hb=c3932ca2c0a741cd2e693bcf5a044747a732757e;hp=2c9e31037d98bd0ffb769395bcdf29404261a6fb;hpb=74d54b121a386cce9eb9f45418c3ad9749cdbf7a;p=openldap diff --git a/doc/man/man3/ldap_extended_operation.3 b/doc/man/man3/ldap_extended_operation.3 index 2c9e31037d..053eb1cf9a 100644 --- a/doc/man/man3/ldap_extended_operation.3 +++ b/doc/man/man3/ldap_extended_operation.3 @@ -12,53 +12,64 @@ OpenLDAP LDAP (libldap, -lldap) #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; +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 .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; +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 .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 +.B ldap_extended_operation_s() +routine is used to synchronously perform an LDAP extended operation. +It takes \fIrequestoid\fP, which points to a dotted-decimal OID string +identifying the extended operation to perform. \fIrequestdata\fP is the +data required for the request, \fIsctrls\fP is an array of LDAPControl +structures to use with this extended operation, \fIcctrls\fP is an array +of LDAPControl structures that list the client controls to use with +this extended operation. +.LP +The output parameter \fIretoidp\fP points to a dotted-decimal OID +string returned by the LDAP server. The memory used by the string +should be freed with the +.BR ldap_memfree (3) +function. +The output parameter \fIretdatap\fP points to a pointer to a berval +structure that contains the returned data. If no data is returned +by the server, the pointer is set this to NULL. The memory used by +this structure should be freed with the +.BR ber_bvfree (3) 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. +.B ldap_extended_operation() +works just like +.BR ldap_extended_operation_s() , +but the operation is asynchronous. 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 .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) +.BR ber_bvfree (3), +.BR ldap_memfree (3), +.BR ldap_parse_extended_result (3), +.BR ldap_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. +.so ../Project