ldap_parse_extended_result (Compact 2013)

3/26/2014

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 LDAPMessage structure as returned by ldap_result in 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 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 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

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 the ldap_memfree function.

Requirements

See Also

Reference

LDAP Search Functions
LDAP_RETCODE
ldap_memfree
LDAPMessage
ldap_msgfree