Export (0) Print
Expand All

LDAP_SERVER_RESP_SORT_OID control code

The LDAP_SERVER_RESP_SORT_OID control is used by the server to indicate the results of a search function initiated using the LDAP_SERVER_SORT_OID control. This control is returned only by the server and should not be sent to the server by a client application.

The server returns results in the members of the LDAPControl structure as follows.

PWCHAR ldctl_oid = LDAP_SERVER_RESP_SORT_OID;
struct berval ldctl_value;
BOOLEAN ldctl_iscritical = FALSE;

Members

ldctl_oid

LDAP_SERVER_RESP_SORT_OID, which is defined as "1.2.840.113556.1.4.474".

ldctl_value

Specifies a BER-encoded sequence that indicates the results of the sorted search request. For more information, see Remarks below.

ldctl_iscritical

Returned as FALSE.

Remarks

The Response Sort control returns the status of a sorted search request previously initiated by using the LDAP_SERVER_SORT_OID control. The returned value is a BER-encoded OCTET STRING that contains the following sequence data.



Sequence {
  sortResult      ENUMERATED
  attributeType   attributeDescription (optional)
}

Client applications should use the ldap_parse_result and ldap_parse_sort_control functions to parse the result fields of this returned control.

The sortResult enumeration elements are listed in the following table.

sortResultDescription

success [0]

results are sorted

operationsError [1]

server internal error

timeLimitExceeded [3]

time limit reached before sorting was completed

strongAuthRequired [8]

refused to return sorted results by using a protocol that is not secure

adminLimitExceeded [11]

too many matching entries for the server to sort

noSuchAttribute [16]

unrecognized attribute type in sort key

inappropriateMatching [18]

unrecognized or inappropriate matching rule in sort key

insufficientAccessRights [50]

refused to return sorted results to this client

busy [51]

too busy to process

unwillingToPerform [53]

unable to sort

other [80]

 

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Header

Winldap.h

See also

Data Structures
LDAPMessage
Using Controls

 

 

Show:
© 2014 Microsoft