2.2.3.166.12 Status (Search)

The Status element is a required child element of the Search element, the Store element, and the gal:Picture element in Search command responses.

Elements referenced in this section are defined in the Search namespace, except where otherwise indicated by the presence of a namespace prefix (as defined in section 2.2.1).

Command request/response

Parent elements

Child elements

Data type

Number allowed

Search command response (section 2.2.2.15)

Search (section 2.2.3.149)

Store (section 2.2.3.167.2)

gal:Picture (section 2.2.3.128.2)

None

integer ([MS-ASDTYPE] section 2.6)

1…1 (required)

As a child element of the Search element, the Status element indicates whether the server encountered an error while it was processing the search query. The Status element value indicates only that the overall Search command request (section 2.2.2.15) was processed correctly. It does not indicate whether any matches were found. The Total (section 2.2.3.173.2) and Range (section 2.2.3.133.2) elements in the Search command response indicate how many matches were found and returned, respectively. The following table specifies valid values for the Status element when it is returned as a child element of the Search element.

Value

Meaning

1

Success

3

Server error

As a child element of the Store element, the Status element indicates whether the server encountered an error while it was processing the Search query for the specified store. The following table specifies valid values for the Status element as a child of the Store element in the Search response.

Value

Meaning

Cause

Scope

Resolution

1

Success.

Server successfully completed command.

Global

None.

2

The request was invalid.

One or more of the client's search parameters was invalid.

Item

If the user formatted the request, prompt the user to retry with different options.

3

An error occurred on the server.

Server misconfiguration, temporary system issue, or bad item. This is frequently a transient condition.

Global

Retry the Search command.

4

Bad link.

A bad link was supplied.

Global

Prompt user to reformat link.

5

Access denied.

Access was denied to the resource

Global

Prompt the user.

6

Not found.

Resource was not found.

Global

Prompt the user.

7

Connection failed.

Failed to connect to the resource.

Global

Prompt the user. Sometimes these are transient, so retry. If it continues to fail, point user to administrator.

8

Too complex.

The query was too complex.

Global

Reduce the complexity of the query. Prompt user if necessary.

10

Timed out.

The search timed out.

Global

The search timed out. Retry with or without rebuilding results. If it continues, contact the Administrator.

11

FolderSync required.

The folder hierarchy is out of date.

Global

Issue a FolderSync command (section 2.2.2.4) and then try the Search command again.

12

End of retrievable range warning.

The requested range has gone past the end of the range of retrievable results.

Local

Prompt the user that there are no more results that can be fetched, and the user might consider restricting their search query.

13

Access blocked.

Access is blocked to the specified resource.

Global

Prompt the user.

14

Credentials required.

To complete this request, basic credentials are required.

Global

If over a trusted connection, supply the basic credentials from the user (prompt if necessary). Otherwise, fail as if the access denied status code was provided.

As a child element of the gal:Picture element, the Status element indicates whether the server encountered an error while it was processing the Search query for the contact photos. The following table shows valid values for the Status element when it is returned as a child of the gal:Picture element.

Value

Meaning

1

The contact photo was retrieved successfully.

173

The user does not have a contact photo.

174

The contact photo exceeded the size limit set by the MaxSize element (section 2.2.3.98.2).

175

The number of contact photos returned exceeded the size limit set by the MaxPictures element (section 2.2.3.97.2).

For information about Status values common to all ActiveSync commands, see section 2.2.4.

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.4, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.

Protocol version

Element support, child of Search, Store

Element support, child of gal:Picture

2.5

X

12.0

X

12.1

X

14.0

X

14.1

X

X

16.0

X

X

The gal:Picture element is supported as a parent of the Status element only when protocol version 14.1 or 16.0 is used.

Show: