CommandOption Enumeration

Options that clients can set only in configuration requests:
- Add
- Replace
- Delete
- Transaction
- Import

Options that clients can set in all requests
- SendWriteValue
- SendErrorMessage
- Poll
- Offline
- UniqueHash
- ValidateRead
- ProcessTimingAsTimespan

Options set by the server or extension:
- PagingHandled


Namespace: TcHmiSrv.Core
Assembly: TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 3.1.7447.0+85f9b473a1dd11b8f3e5c9a182fd1901975e46f9

Syntax

C#

[FlagsAttribute]
public enum CommandOption

Members

Member name

Value

Description

None

0

 

SendWriteValue

1

Send the writeValue for requests back to the client.

SendErrorMessage

2

Add error message and reason to the response. By default, only the error code is returned.

Poll

4

For subscriptions only: Send a response for each subscription tick, even if the data has not changed.

Offline

8

Do not pass the symbol to the extension, simulate it instead.

Config

16

 

UniqueHash

32

Do not merge subscriptions.

Add

64

When using vectors, add the entry at the end instead of replacing it.

Replace

128

Replace the whole data structure instead of partially updating it.

ValidateRead

512

Validate the readValue against the symbol's JSON schema before sending it to the client.

Delete

1,024

Deletes the given vector or map entry.

PagingHandled

2,048

Paging for this symbol has been done, if this option is not set, the server will do the paging.

Transaction

4,096

If one of the commands in the request fails all changes will be rolled back.

ProcessTimingAsTimespan

8,192

Use TimeSpan instead of DateTime for the processedStart and processedEnd fields.

Import

16,384

BeforeChange handlers are sent to the BeforeImport handler and the whole config is sent for easier validation.

Extension1

65,536

 

Extension2

131,072

 

Extension3

262,144

 

Extension4

524,288

 

Version Information

Supported in: 3.1.7447.0, 2.3.7447.0, 1.10.7447.0

Reference

TcHmiSrv.Core Namespace

Copyright © Beckhoff Automation GmbH & Co. KG