ldap_parse_extended_result

The ldap_parse_extended_result parses the results of an LDAP extended operation.

ULONG ldap_parse_extended_result(
  LDAP Connection,
  LDAPMessage* ResultMessage,
  PCHAR* ResultOID,
  struct berval** ResultData,
  BOOLEAN Freeit
);

Parameters

Connection

[in] The session handle.

ResultMessage

[in] A pointer to an LDAPMessage structure as returned by ldap_result in response to an extended operation request.

ResultOID

[out] A pointer to a null-terminated string that contains the dotted object identifier (OID) text string of the server's response message. This is normally the same OID as the one naming the request that was originally passed to the server by ldap_extended_operation.

ResultData

[out] The arbitrary data returned by the extended operation (if NULL, no data is returned by the server).

Freeit

[in] Determines whether the ResultMessage parameter is freed. You can pass any nonzero value to the Freeit parameter to free the ResultMessage pointer when it is no longer needed, or you can call ldap_msgfree to free the result later.

Return Values

If the function succeeds, the return value is LDAP_SUCCESS.

If the function fails, it returns an error code. See Return Values for more information.

Remarks

When a server processes an extended operation request generated by ldap_extended_operation, it returns an LDAP message along with an LDAP_RES_EXTENDED return code. Use ldap_parse_extended_result to parse this result message, which returns both the text OID of the originating message in ResultOID and any arbitrary data generated by the extended operation in ResultData.

When they are no longer needed, free the ResultOID string and the ResultData buffer by calling ldap_memfree.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Redistributable: Requires Active Directory Client Extension on Windows NT 4.0 SP6a and Windows 95/98/Me.
Unicode: Implemented as Unicode and ANSI versions on all platforms.
Header: Declared in Winldap.h.
Library: Use Wldap32.lib.

See Also

Functions, LDAPMessage, ldap_extended_operation, ldap_result, ldap_memfree, ldap_msgfree, Return Values