ldap_parse_sort_control (Compact 2013)

3/26/2014

This function parses the sort control returned by the server.

Syntax

ULONG ldap_parse_sort_control(
  LDAP* ExternalHandle,
  LDAPControl** Control,
  ULONG* Result,
  UNICODE PTCHAR* Attribute
);

Parameters

• ExternalHandle
  [in] Session handle.

• Control
  [in] Control returned from the server, as obtained from a call to ldap_parse_result.

• Result
  [out] Result code.

• Attribute
  [out] Name of the attribute that caused the operation to fail.

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 the server returns the results, it returns a control in the SearchResultDone message. Call this function to parse this sort control.

If the sort operation failed, the server may return the name of the attribute that caused the failure. In this case, call ldap_memfree to free the attribute value.

Requirements

See Also

Reference

LDAP Search Functions
LDAP_RETCODE
ldap_memfree
ldap_parse_result