2.2.3.143.1 Range (Find)

The Range element is an optional child element of the Options element in Find command requests that specifies the maximum number of matching entries to return.  The Range element is an optional child element of the Response element in Find command responses that specifies the number of matching entries that are being returned.

All elements referenced in this section are defined in the Find namespace.

Command request/response

Parent elements

Child elements

Data type

Number allowed

Find command request (section 2.2.1.2)

Options (section 2.2.3.125.1)

None

string ([MS-ASDTYPE] section 2.7)

0...1 (optional)

Find command response

Response (section 2.2.3.153.2)

None

string

0...1 (optional)

The format of the Range element value is in the form of a zero-based index specifier, formed with a nonnegative integer, a hyphen, and another nonnegative integer of higher value than the first. The m indicates the lowest index of a zero-based array that would hold the items. The n indicates the highest index of a zero-based array that would hold the items. The Range element has possible values for m and n of 0 ≤ mn ≤ 999. For example, a Range element value of 0–9 indicates 10 items, and 0–10 indicates 11 items. A Range element value of 0–0 indicates 1 item.

If the client is making its first Find command request for a given search, it MUST start with a Range element value of "0-n".

If the Find request does not include a Range element, the default range value for Mailbox searches is used. If the Find request includes a Range element, the server can return fewer results than requested.

The Total element SHOULD be used by the client to increment the Range element in subsequent Find requests.

Protocol Versions

The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.

Protocol version

Element support

2.5

12.0

12.1

14.0

14.1

16.0

16.1

Yes