2.2.3.177.15 Status (Settings)

  • Article

The Status element is a required child element of the Settings element, the RightsManagementInformation element, the Oof element, the DevicePassword element, the DeviceInformation element, and the UserInformation element in Settings command responses. It contains a code that indicates either the overall success or failure of the Settings command request (section 2.2.1.18) or the success or failure of a Get (section 2.2.3.83) or Set (section 2.2.3.167) operation.

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

Command request/response

Parent elements

Child elements

Data type

Number allowed

Settings command response

Settings (section 2.2.3.168.2)

RightsManagementInformation (section 2.2.3.156)

Oof (section 2.2.3.122)

DevicePassword (section 2.2.3.46)

DeviceInformation (section 2.2.3.45)

UserInformation (section 2.2.3.192)

None

integer ([MS-ASDTYPE] section 2.6)

1...1 (required)

As a child element of the Settings element in the Settings command response, the Status element indicates the overall success or failure of the Settings command request. The following table lists the valid values for the Status element as the child element of the Settings element in the Settings command response.

Value

Meaning

1

Success.

2

Protocol error.

3

Access denied.

4

Server unavailable.

5

Invalid arguments.

6

Conflicting arguments

7

Denied by policy

Error code values 100 to 255 are reserved for property-specific error codes and vary from property to property. Any status value that is not 1 is a failure.

The following table lists the valid values for Status in a Settings command RightsManagementInformation Get operation, Oof Get operation, Oof Set operation, DeviceInformation Set operation, or UserInformation Get operation.

Value

Meaning

1

Success.

2

Protocol error. The XML code is formatted incorrectly.

5

Invalid arguments.

6

Conflicting arguments.

For a Settings command Oof Set operation, if Oof nodes AppliesToExternalKnown (section 2.2.3.12) or AppliesToExternalUnknown (section 2.2.3.13) are not allowed and are disabled by the administrator but are sent by the client in the Settings command Set operation request, the Settings command Set operation response returns a successful Status element value of 1 even though the user does not have access to these settings.

The following table lists the values for Status in a Settings command DevicePassword Set response.

Value

Meaning

1

Success.

2

Protocol error. The XML code is formatted incorrectly.

5

Invalid arguments. The specified password is too long.

7

Denied by policy. The administrator has disabled password recovery in this deployment.

For Status values common to all ActiveSync commands, see section 2.2.2.

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, child of RightsManagementInformation

Element support, child of other elements

2.5

12.0

Yes

12.1

Yes

14.0

Yes

14.1

Yes

Yes

16.0

Yes

Yes

16.1

Yes

Yes

The following elements are supported as a parent element of the Status element when protocol version 12.0, 12.1, 14.0, 14.1, 16.0, or 16.1 is used.

  • Settings

  • Oof

  • DevicePassword

  • DeviceInformation

  • UserInformation

The RightsManagementInformation element is supported as a parent of the Status element only when protocol version 14.1, 16.0, or 16.1 is used.