2.2.3.124 OofState

The OofState element is an optional child element of the Set element in Settings command requests and an optional child element of the Get element in Settings command responses. It specifies the availability of the Oof property (section 2.2.3.122).

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 Oof request (section 2.2.1.18)

Set (section 2.2.3.167)

None

integer ([MS-ASDTYPE] section 2.6)

0...1 (optional)

Settings command Oof response

Get (section 2.2.3.83)

None

integer

0...1 (optional)

The following table lists the valid values for OofState.

Value

Meaning

0

The Oof property is disabled.

1

The Oof property is global.

2

The Oof property is time-based.

The OofState element value MUST be set to 2 if the StartTime (section 2.2.3.176.2) and EndTime (section 2.2.3.61.2) elements are present. If the OofState element value is not set to 2 and the StartTime and EndTime elements are submitted in the request, the client does receive a successful response message, but the server does not store the StartTime and EndTime element values.

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

Yes

12.1

Yes

14.0

Yes

14.1

Yes

16.0

Yes

16.1

Yes

Show: