ldap_extended_operation

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function allows you to pass extended LDAP operations to the server.

Syntax

ULONG ldap_extended_operation(
  LDAP* ld,
  UNICODE PTCHAR Oid,
  struct berval* Data,
  LDAPControl** ServerControls,
  LDAPControl** ClientControls,
  ULONG* MessageNumber
);

Parameters

• ld
  [in] Session handle.

• Oid
  [in] Dotted object identifier (OID) text string naming the request.

• Data
  [in] Arbitrary data required by the operation. If NULL, no data is sent to the server.

• ServerControls
  [in] List of LDAP server controls.

• ClientControls
  [in] List of client controls.

• MessageNumber
  [out] Message identifier for the request.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

If this function fails, it returns an error code. See the LDAP_RETCODE enumeration for a list of possible return values.

Remarks

This function allows a client to send an extended request (free for all) to an LDAP 3 (or later) server. The functionality is open and the client request can be for any operation, requiring single or multiple responses.

As an asynchronous function, this function returns a message identifier for the operation. Call the ldap_result function with the message identifier to get the result of the operation. To cancel an asynchronous operation before it has completed, call the ldap_abandon function.

Because of the open nature of the request, the client must call the ldap_close_extended_op function to terminate the request.

In a multithreading environment, calls to ldap_extended_operation are thread-safe.

Requirements

See Also

Reference

LDAP_RETCODE
ldap_abandon
ldap_close_extended_op
ldap_result