LDAPSortKey

A version of this page is also available for

4/8/2010

This structure stores sorting criteria for use by sort controls.

Syntax

typedef struct ldapsortkey {
  PWCHAR sk_attrtype;
  PWCHAR sk_matchruleoid;
  BOOLEAN sk_reverseorder;
} LDAPSortKey, *PLDAPSortKey;

sk_attrtype
Pointer to a null-terminated string that specifies the name of the attribute to use as a sort key. Use multiple LDAPSortKey structures to specify multiple sort keys.

Note

Active Directory supports only a single sort key.

sk_matchruleoid
Pointer to a null-terminated string that specifies the object identifier (OID) of the matching rule for the sort.

sk_reverseorder
If TRUE, specifies that the sort be ordered from lowest to highest.

The ldap_create_sort_control and ldap_search_init_page functions use this structure to specify how results should be sorted before being returned to the client.

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