Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function parses the results of an LDAP extended operation.

Syntax 

ULONG ldap_parse_extended_result(
  LDAP 
Connection,
  LDAPMessage* 
ResultMessage,
  UNICODE PTCHAR* 
ResultOID,
  struct berval** 
ResultData,
  BOOL 
Freeit
);

Parameters

Connection

[in] Session handle.

ResultMessage

[in] Pointer to an LDAPMessagestructure as returned by ldap_resultin response to an extended operation request.

ResultOID

[out] Dotted object identifier (OID) text string naming the request that was originally passed to the server by ldap_extended_operation.

ResultData

[out] Arbitrary data returned by the extended operation. If NULL, no data is returned by the server.

Freeit

[in] Determines whether the ResultMessageparameter is freed. You can pass any nonzero value to the Freeitparameter to free the ResultMessagepointer when it is no longer needed, or you can call ldap_msgfreeto free the result later.

Return Value

If this function succeeds, the return value is LDAP_SUCCESS.

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

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_resultto parse this result message, which returns both the text OID of the originating message in ResultOIDand any arbitrary data generated by the extended operation in ResultData.

When they are no longer needed, free the ResultOIDstring and the ResultDatabuffer by calling the ldap_memfreefunction.

Requirements

Header winldap.h
Library wldap32.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also