"TcHmiSrvExt"
Allows clients to get string representations for error codes to improve readability.
The requested error code.
The text representation of the error code.
Called on server startup.
The initialization of the extension.
Additional information about the current extension.
if initializing the extension succeeded; otherwise, any
that best describes which error has occurred.
Allows extensions to be loaded by the server.
Extensions have to implement this interface and contain the following method to be loaded by the server.
After the ext_interface call the server will create the extension configuration and call the init method.
Changes the friendly name of a TwinCAT HMI server extension.
A containing information about the domain of the
TwinCAT HMI server extension whose friendly name should be changed.
The new friendly name.
Triggers a refresh of the list of events provided by an extension that implements the
.
A containing information about the user who tries to refresh it and
the domain of the extension that should be refreshed.
Gets the configuration at the specified path from the server.
A containing information about the user who tries to get a
configuration .
The path of the requested .
The at the specified path or a containing
.
Tries to add an entry to a map or vector in the extension configuration or update an existing
configuration . Since the config is set
asynchronously, you cannot rely on the really being set after this method
returned. Therefore, you must verify this by using or
calling .
A containing information about the user who tries to set a
configuration .
The path of the to be set.
The to be set or nullptr to delete the configuration
at specified path.
if starting an asynchronous operation to set the
configuration succeeded; otherwise, any that
best describes which error has occurred.
Sends a notification if an should be removed.
The under which the
changed.
The that should be removed.
if sending the notification succeeded; otherwise, any
that best describes which error has occurred.
Sends a notification if an type changed.
The under which the
changed.
Contains the type of the change.
The that has changed.
if the listener was notified
successfully.
Unregisters an at the server.
The under which the
should be unregistered.
The that should be unregistered. Listeners for
the extension domain are unregistered automatically during shutdown. Listeners for other domains must be
unregistered manually using the .
Registers an for a different domain at the server. This is
only supported for
The under which the
should be registered.
The domain for which the listener that should be registered.
The that should be registered.
A containing the settings that should be used at the
registration.
if the listener was registered successfully.
Registers an at the server using the specified settings.
The under which the
should be registered.
The that should be registered.
A containing the settings that should be used at the
registration.
if the listener was registered successfully.
Registers an for a different domain at the server. This is
only supported for
The under which the
should be registered.
The domain for which the listener that should be registered.
The that should be registered.
if the listener was registered successfully.
Registers an at the server.
The under which the
should be registered.
The that should be registered.
if the listener was registered successfully.
Localizes an .
The under which the
should be localized.
The to be localized.
A string containing the localized text or the event name.
Localizes an .
The under which the
should be localized.
The to be localized.
A string containing the localized text or the event name. An empty string if the localization is
currently unavailable.
Executes a single in the domain of the specified
.
The under which the should be
executed.
The to be executed.
if executing the
succeeded; otherwise, any that best describes which error has
occurred.
Executes s inside any domain.
The under which the commands should be executed.
A containing a list of
s.
if executing the commands succeeded; otherwise, any
that best describes which error has occurred.
Adds or updates an .
The under which the should be
sent.
The that will be sent to the server and all current event
listeners.
Specifies whether the is stored persistently.
if sending the succeeded;
otherwise, any that best describes which error has occurred.
Adds a .
The under which the should be
sent.
The that will be sent to the server and all current event
listeners.
Specifies whether the is stored persistently.
if sending the
succeeded; otherwise, any that best describes which error has
occurred.
Adds or updates an .
The under which the should be
sent.
The that will be sent to the server and all current event
listeners.
if sending the succeeded;
otherwise, any that best describes which error has occurred.
Adds a .
The under which the should be
sent.
The that will be sent to the server and all current event
listeners.
if sending the
succeeded; otherwise, any that best describes which error has
occurred.
This interface is used to communicate with the server.
Gets the type of the listener.
The type of the listener.
Called when a user is being logged out.
A containing the currently logged in user.
if logout succeeded; otherwise, any
that best describes which error has occurred.
Called when a user tries to log in.
A containing information about the user who tries to log
in.
A struct that describes the Json schema "Login" in TcHmiSrv.Config.json. Set a
'replaceUserGroups' vector of strings with user group names to change group assignments of the logged in
user. Set a 'replaceUserName' string to create the new session with a different user. Add boolean
'forcePasswordChange' to force the current user to change the password after logging in
if login succeeded; otherwise, any
that best describes which error has occurred. Set replaceUserGroups Vector of
String with user group names in "value" to change group assignments of the logged in user.
Allows to implement own authorization extensions.
Gets the type of the listener.
The type of the listener.
Called when a client closes a subscription.
A containing information about the user who closed the
subscription.
if unregistering the subscription succeeded; otherwise,
any that best describes which error has occurred.
Called once when a client opens a new subscription.
The subscription will call the on_request method of once per
interval.
A containing information about the user who opened the
subscription.
if registering the subscription succeeded; otherwise,
any that best describes which error has occurred.
Allows to take full control over the subscription loops.
If this interface is not implemented, subscriptions will just call the
method.
Gets the type of the listener.
The type of the listener.
Called when a client requests a symbol from the extension domain.
If the request is a subscription, this method will be called multiple times.
Inside a subscription the data will only be sent to clients if either the read value or the return codes
changed.
This will be detected automatically, so do not use set the result or read value unless the data has changed.
The of the request.
A containing a list of
s.
Performs read write requests and subscriptions.
Gets the type of the listener.
The type of the listener.
Called when the server is shutting down. After exiting this function the extension will be unloaded.
The of the shutdown.
if shutting down the extension succeeded; otherwise,
any that best describes which error has occurred.
Allows to get notified when the server is shutting down.
Gets the type of the listener.
The type of the listener.
Triggered session is removed.
Contains the clients session information.
that best describes which error has occurred.
Triggered when a new session is created.
Contains the clients session information.
that best describes which error has occurred.
Triggered when a websocket connection is closed.
Contains the clients session information including the id of the socket.
if closing the websocket succeeded; otherwise, any
that best describes which error has occurred.
Triggered when a new websocket connection is opened.
Contains the clients session information including the id of the socket.
if creating the websocket succeeded; otherwise, any
that best describes which error has occurred.
Triggered when a user is logged out.
Contains the clients session information.
if logout succeeded; otherwise, any
that best describes which error has occurred.
Triggered when a user is logged in.
Contains the clients session information.
if login succeeded; otherwise, any
that best describes which error has occurred.
Allows to observe the servers connection state.
Gets the type of the listener.
The type of the listener.
Called after a configuration has been renamed.
The of the renaming.
The old path of the configuration .
The new path of the configuration .
The name of the JSON schema reference of the changed object.
A containing if
renaming the configuration
succeeded; otherwise, any that best describes
which error has occurred.
Called after a configuration has been deleted.
This method is also called for all parent elements in the path of the deleted configuration
.
The of the deletion.
The path of the configuration .
A copy of the deleted .
The name of the JSON schema reference of the changed object.
A containing if
deleting the configuration
succeeded; otherwise, any that best describes
which error has occurred.
Called after a configuration has been successfully changed.
This method is also called for all parent elements in the path of the changed configuration
.
The of the change.
The path of the configuration .
The name of the JSON schema reference of the changed object.
A containing if
changing the configuration
succeeded; otherwise, any that best describes
which error has occurred.
Called before a configuration is renamed.
If the call is not answered with , renaming will be aborted.
The of the renaming.
The old path of the configuration .
The new path of the configuration .
The name of the JSON schema reference of the changed object.
A containing if the
should be renamed;
otherwise, any that best describes which error has occurred.
Called before a configuration is deleted.
If the call is not answered with , deletion will be aborted.
The of the deletion.
The path of the configuration .
The that is about to be deleted.
The name of the JSON schema reference of the changed object.
A containing if the
value should be deleted; otherwise, any
that best describes which error has occurred.
Called before a configuration is changed.
If the call is not answered with , the write will be aborted.
This method is also called for all parent elements in the path of the changed configuration
.
The of the change.
The path of the configuration .
The that is about to be changed.
The name of the JSON schema reference of the changed object.
A containing if the
should be changed;
otherwise, any that best describes which error has occurred.
Allows to interact with the extension configuration.
Gets the type of the listener.
The type of the listener.
Called after a command group was executed.
The of the request.
The id of the request.
The of the request.
Called before a command group is executed.
The of the request.
The id of the request.
The of the request.
Allows to react on global websocket requests.
Gets the type of the listener.
The type of the listener.
Called on an HTTP request.
The of the HTTP request.
A representing the HTTP request.
A representing the HTTP response.
A containing if the
HTTP request succeeded; otherwise, any that best describes which error has
occurred.
Allows to react on HTTP requests.
Gets the type of the listener.
The type of the listener.
Called before an import is done.
If the call is not answered with , the write will be aborted.
With complex data, this method is called for every path.
The of the export.
The path of the configuration .
The that is about to be exported.
The root containing the whole data that is going to be
imported.
The name of the JSON schema reference of the changed object.
A containing if the
should be exported; otherwise, any that best
describes which error has occurred.
Called before an export is done.
If the call is not answered with , the write will be aborted.
With complex data, this method is called for every path.
The of the export.
The path of the configuration .
The that is about to be exported.
The root containing the whole data that is going to be
exported.
The name of the JSON schema reference of the changed object.
A containing if the
should be exported; otherwise, any that best
describes which error has occurred.
Allows to react on configuration export calls.
Gets the type of the listener.
The type of the listener.
Called when the s are listed.
The under which the s are listed.
A that contains the s in its read-value.
if listing the s
succeeded; otherwise, any that best describes which
error has occurred.
Called when an extension is loaded and it's initial list of s is fetched.
The of the change.
Unique identifier of an extension that changes when the extension is
reloaded.
The vector of s
received from the other extension.
if changing the
succeeded; otherwise, any that best describes which error has occurred.
Called when an is removed.
The of the removal.
The that should be removed.
Unique identifier of an extension that changes when the extension is
reloaded. Empty if the extension that changed the event doesn't implement
.
if removing the
succeeded; otherwise, any that best describes which error has
occurred.
Called when an is changed.
The of the change.
The that has changed.
Unique identifier of an extension that changes when the extension is
reloaded. Empty if the extension that changed the event doesn't implement
.
if changing the
succeeded; otherwise, any that best describes which error has
occurred.
Allows to interact with the eventing system of the server.
Gets the type of the listener.
The type of the listener.
Called when the s are listed once upon successful initialization.
The under which the s are listed.
A that contains the s.
if listing the s
succeeded; otherwise, any that best describes which
error has occurred.
Called when an is confirmed.
The of the confirmation.
The that is confirmed.
if the confirmation succeeded; otherwise, any
that best describes which error has occurred.
Allows to listen on provided s.
Gets the type of the listener.
The type of the listener.
Called when a event cannot be localized using the language file of the extension.
This event can be used to implement dynamic localization.
The of the localization.
A locale in BCP 47 representation.
The that needs to be localized.
The resulting localized string.
if localizing the
succeeded; otherwise, any that best describes which error has
occurred.
Allows to interact with the eventing system of the server.
Gets the type of the listener.
The type of the listener.
Listeners are called whenever the corresponding event in the server occurs.
Gets the type of the .
()
The type of the .
Gets the domain that triggered the .
The domain that triggered the .
Sets the domain that triggered the .
The domain that triggered the .
Get the name of the .
The name of the .
Sets the name of the .
The name of the .
Gets the parameters of the .
A that contains the parameters of the
.
Gets the confirmation state of the .
The confirmation state of the .
Sets the confirmation state of the .
The confirmation state of the .
Gets the active state of the .
The active state of the .
Sets the alarm's active state. The active state is automatically generated from the alarm state and the
confirmation state values. You should only use this if you explicitly want to set a different value. The value
you have set will be overwritten as soon as the alarm state or the confirmation state are changed.
The state to use as an override.
Gets the state of the .
The state of the .
Sets the alarm state. The alarm state is automatically generated from the time_cleared and time_confirmed
values. You should only use this if you explicitly want to set a different value. The value you have set will
be overwritten as soon as time_cleared or time_confirmed are changed.
The state to use as an override.
Gets the time the was confirmed.
A that represents the time the was
confirmed.
Sets the time the was confirmed.
A that represents the time the
was confirmed.
Gets the time the was cleared.
A that represents the time the was
cleared.
Sets the time the was cleared.
A that represents the time the
was cleared.
Gets the time the was raised.
A that represents the time the was
raised.
Sets the time the was raised.
A that represents the time the
was raised.
Gets the of the .
The of the .
Sets the of the .
The of the .
Gets the unique id of the .
The unique id of the .
Sets the unique id of the .
The unique id of the .
Gets a value that indicates whether the is set.
true if the is set; otherwise, false.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class with the specified
and name.
The to be set.
The name to be set.
Initializes a new instance of the class.
This class can be used as payload for the class.
Gets the type of the .
()
The type of the .
Gets the domain that triggered the .
The domain that triggered the .
Sets the domain that triggered the .
The domain that triggered the .
Gets the name of the .
The name of the .
Sets the name of the .
The name of the .
Gets the parameters of the .
A map that contains the parameters of the .
Gets the of the .
The of the .
Sets the of the .
The of the .
Sets the time the was raised.
A that represents the time the
was raised.
Gets the time the was raised.
A that represents the time the was
raised.
Gets a value that indicates whether the is set.
true if the is set; otherwise, false.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class with the specified
, and name.
The to be set.
The to be set.
The name to be set.
Initializes a new instance of the class.
Holds data for a message.
Gets the domain of the .
The domain of the .
Sets the domain of the .
The domain of the .
Gets the name of the .
The name of the .
Sets the name of the .
The name of the .
Gets the payload of the .
The payload of the .
Sets the payload of the .
The payload of the .
Gets the of the .
The of the .
Sets the of the .
The of the .
Gets the time the event was received by the server.
A that represents the time the event was received by the
server.
Sets the time the event was received by the server.
A that represents the time the event was received
by the server.
Gets a value that indicates whether the is set.
true if the is set; otherwise, false.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class.
Holds data for an event.
Gets an identifier for subscriptions.
An identifier for subscriptions. If the context does not belong to a subscription, zero is
used.
Sets an identifier for subscriptions.
An identifier for subscriptions. Use zero if the context does not belong to a
subscription.
Gets a hash value to identify identical sets.
A hash value to identify identical sets.
Sets a hash value to identify identical sets.
A hash value to identify identical sets.
Gets the currently active domain.
The currently active domain.
Sets the currently active domain.
The currently active domain.
Gets the type of the request that is currently being executed.
The type of the request that is currently being executed.
Sets the type of the request that is currently being executed.
The type of the request that is currently being executed.
Gets the of the currently active user.
The of the currently active user.
Gets the constant of the currently active user.
The constant of the currently active user.
Sets the of the currently active user.
The of the currently active user.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class.
Holds information about the current application context.
Gets the endpoint information.
The endpoint information.
Sets the endpoint information.
The endpoint information.
Gets the socket id of the .
The socket id of the .
Sets the socket id of the .
The socket id of the .
Gets the locale of the user in BCP 47 representation.
The locale of the user in BCP 47 representation.
Sets the locale of the user in BCP 47 representation.
The locale of the user in BCP 47 representation.
Gets the user name.
The user name prefixed with the domain of the TwinCAT HMI authentication server extension.
Sets the user name.
The user name.
Gets the id of the session.
The id of the session.
Sets the id of the .
The id of the .
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class.
Holds session information for the active user.
Gets a value that indicates whether the is set.
true if the is set; otherwise, false.
Removes all s from the .
Reserves memory for a number of s to reduce memory allocations.
The number of s for which memory should be reserved.
Gets a value that indicates whether the is empty.
true if the is empty; otherwise, false.
Gets the number of s in the .
The number of s in the .
Accesses a in the at the specified
index.
The index of the to get.
The at the specified index or a null if
the does not exist.
Gets the group result.
The group result.
Sets the group result.
The group result.
Gets the name of the domain.
The name of the domain.
Sets the name of the domain.
The name of the domain.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class with the specified domain.
The name of the domain.
Initializes a new instance of the class.
Holds a group of commands to server symbols or extension symbols.
Time when the data has been processed.
Returns the time when the data in this command finished processing.
Set this after obtaining the data from the data source. The value is used for validation in the client.
If the exact time of the data change is known processed_start and processed_end can be equal.
Optional. Time the contained finished processing. Timespan::steady_now() should be used to
avoid timing issues. If time is omitted the API will set the correct time.
Time when the data started being processed.
Returns the time when the data in this command started being processed.
Set this before obtaining the data from the data source. The value is used for validation in the
client. If the exact time of the data change is known processed_start and processed_end can be equal.
Optional. Time the contained data started being processed, Timespan::steady_now() should be
used to avoid timing issues. If time is omitted the API will set the correct time.
Gets a value that indicates whether the is set.
true if the is set; otherwise, false.
Exchanges the values of two instances of the class.
The other .
true if the swap was successful; otherwise, false.
Sets the version of the symbol to be executed. Defaults to the latest version.
The symbol version to use. 0.0 for the latest version.
The version of the symbol to be executed.
The symbol version to use. 0.0 for the latest version.
Sets a value that indicates whether the has changed.
true if the has changed; otherwise, false.
Gets a value that indicates whether the has changed.
true if the has changed; otherwise, false.
Gets the path of the mapping.
PLC1::MAIN::test
The path of the mapping.
Gets optional extension data associated with this . This can be used to
get additional information of this command.
The extension data associated with this .
Sets optional extension data associated with this . This can be used to
add additional information to the command.
The extension data associated with this .
Gets the customer data associated with this . This can be used to
identify multiple calls to the same method in one request.
The customer data associated with this .
Sets the customer data associated with this . This can be used to
identify multiple calls to the same method in one request.
The customer data associated with this .
Gets the filter of the symbol used by this . Filters can be used to set
rules for reducing the size of returned arrays or maps.
If your extensions handles the filtering or paging itself set CommandOption PagingHandled.
The filter of the symbol used by this .
Returns whether the result will be filtered.
True if the result will be filtered, otherwise false.
Gets the options of the symbol used by this .
The options of the symbol used by this .
Returns whether the command has specific symbol options.
True if the result has symbol options, otherwise false.
Gets the write value of the . If write value is set, the symbol should
be written first and read afterwards.
The write value of the .
Sets the write value of the .
The write value of the .
Gets the read value of the .
The read value of the .
Sets the read value of the .
The read value of the .
Sets the server result of the .
The server result of the .
Gets the server result of the .
The server result of the .
Gets the result string.
The result string.
Sets the result string of the .
The result string of the .
Gets the extension result.
The extension result.
Sets the extension result of the .
The extension result of the .
Gets the result of the symbol.
The result of the symbol.
Gets the command options of the symbol.
The command options of the symbol.
Sets the command options of the symbol.
The command options of the symbol.
Gets the domain of the symbol.
The domain of the symbol.
Gets the mapping of the symbol.
The mapping of the symbol.
Gets the name of the symbol.
The name of the symbol.
Sets the name of the symbol.
The name of the symbol.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class with the specified name.
The name to be set.
Initializes a new instance of the class.
Holds a single command to server symbols or extension symbols.
Tries to convert the to another . If
conversion fails, the will remain unchanged.
Available conversions are:
- int to double
- int64 to double if the integer can be represented exactly
- uint64 to double if the integer can be represented exactly
- double to int if there are no fractional digits
- string containing number to double or int
- string containing "true" or "false" to boolean
- string in ISO-8601 to timestamp
- string in base64 to binary
- string in base64 containing 64 bit integer to int64
- string in base64 containing 64 bit unsigned integer to uint64
- struct to alarm
- struct to message
- struct to event
- map to vector
- struct to vector
The to convert to.
The converted .
Sets the to the specified instance of the
class.
The to be set.
Sets the to the specified instance of the
class.
The to be set.
Sets the to the specified instance of the
class.
The to be set.
Sets the to the specified instance of the
class.
The to be set.
Sets the to the specified instance of the
class.
The to be set.
Sets the to the specified instance of the
class.
The to be set.
Sets the to the specified uint64.
The uint64 to be set.
Sets the to the specified int64.
The int64 integer to be set.
Sets the to the specified integer.
The integer to be set.
Sets the to the specified double-precision floating-point number.
The double-precision floating-point number to be set.
Sets the to the specified boolean value.
The boolean value to be set.
Sets the to the specified string.
The string to be set.
Gets the type of the .
The type of the .
Sets the type of the . If the is
different from the old all data will be cleared.
The type of the .
Gets a value that indicates whether the is set.
true if the is set; otherwise, false.
Exchanges the values of two instances of the class.
The other .
true if the swap was successful; otherwise, false.
Reserves memory for a number of s to reduce memory allocations.
The number of s for which memory should be reserved.
Gets a value that indicates whether the is empty.
true if the is empty; otherwise, false.
Gets the number of s in the map or vector.
The number of s in the map or vector.
Changes the number of elements in a vector.
New container size, expressed in number of elements.
that is copied to the added elements in case that n is greater
than the current container size.
Removes all s from the map or vector.
Removes a range of s from the vector.
The index of the first that should be removed.
The index of the last that should be removed.
if the s have been
removed;
otherwise, any that best describes which error has occurred.
Removes a at the specified index from the vector.
The index of the that should be removed.
if the has been removed
or if the does not
exist.
Adds a to the end of the vector.
The of the to add.
The that has been added.
Accesses a in the map specified by the name.
The name of the to get.
The specified by the name or a null
if the does not exist.
Accesses a in the map specified by the name.
The name of the to get.
The specified by the name or a null
if the does not exist.
Accesses a in the vector at the specified index.
The index of the to get.
The at the specified index or a null if the
does not exist.
Initializes a new instance of the class with the specified instance of
the class.
The to be set.
Initializes a new instance of the class with the specified instance of
the class.
The to be set.
Initializes a new instance of the class with the specified instance of
the class.
The to be set.
Initializes a new instance of the class with the specified instance of
the class.
The to be set.
Initializes a new instance of the class with the specified instance of
the class.
The to be set.
Initializes a new instance of the class with the specified instance of
the class.
The to be set.
Initializes a new instance of the class with the specified string.
The string to be set.
Initializes a new instance of the class with the specified uint64.
The uint64 to be set.
Initializes a new instance of the class with the specified int64.
The int64 to be set.
Initializes a new instance of the class with the specified integer.
The integer to be set.
Initializes a new instance of the class with the specified
ConfigChangeType.
ConfigChangeType to be set.
Initializes a new instance of the class with the specified
double-precision floating-point number.
The double-precision floating-point number to be set.
Initializes a new instance of the class with the specified boolean value.
The boolean value to be set.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class.
Represents an object to hold values of any including maps and vectors.
Gets a value that indicates whether the is set.
true if the is set; otherwise, false.
Gets the name of the .
The name of the .
Sets the name of the .
The name of the .
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class with the specified name.
The name to be set.
Initializes a new instance of the class.
Represents an object to hold string variables.
Gets the of the .
The of the .
Gets the of the that will be
usually or
.
The of the .
Gets the parameters of the . The parameter names have to match the
placeholders in the localization string.
A map of parameters.
Gets the domain of the language variable. The language file of this domain will be used for
localization.
The domain of the language variable.
Gets the name of the language variable.
The name of the language variable.
Sets the name of the language variable.
The name of the language variable.
Declares an interface for a localizable object that holds a language variable and parameters.
Gets the number of nanoseconds from the current .
The number of nanoseconds that the current holds.
Gets the number of milliseconds from the current .
The number of milliseconds that the current holds.
Gets the number of seconds from the current .
The number of seconds that the current holds.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class with the specified number of
nanoseconds.
The nanoseconds to be set.
Initializes a new instance of the class.
Holds a period of time in nanoseconds.
Gets the number of nanoseconds from the current .
The number of nanoseconds that the current holds.
Gets the number of milliseconds from the current .
The number of milliseconds that the current holds.
Gets the number of seconds from the current .
The number of seconds that the current holds.
Gets the current from a steady clock.
Gets the current .
Creates a from a number of milliseconds since 1 January 1970.
The number of milliseconds since 1 January 1970.
A that represents the given number of milliseconds since 1 January
1970.
Creates a from a Windows file time.
The Windows file time.
A that represents the given Windows file time.
Creates a from an unix timestamp.
The unix timestamp.
A that represents the given unix timestamp.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class with the specified number of
nanoseconds.
The nanoseconds to be set.
Initializes a new instance of the class.
Holds a time in nanoseconds since '21 September 1677 00:12:43.145224192' (UTC) until '11 April 2262
23:47:16.854775807' (UTC). The zero (default) value is '01 January 1970 00:00:00.00000000' (UTC).
Gets the .
Sets the .
Gets the textual representation or further description of the result code.
Sets the textual representation or further description of the result code.
Initializes a new instance of the class based on another
.
The other .
Initializes a new instance of the class.
The result code, see .
The textual representation or further description of the result code.
Initializes a new instance of the class.
The result code, see .
Initializes a new empty instance of the class.
Holds results of API calls.
Gets a value that indicates whether the is valid.
true if the is valid; otherwise, false.
Gets a value that indicates whether the is empty.
true if the is empty; otherwise, false.
Contains the data of the binary string.
Represents the size of the binary string.
Holds a binary string.
Options that clients can set only in configuration requests:
- Add
- Replace
- Check
- 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
before_change handlers of the ITcHmiSrvConfigListener are sent to the before_import handler of the
ITcHmiSrvExportListener and the whole config is sent for easier validation.
Use TimeSpan instead of Timestamp for the processedStart and processedEnd fields.
If one of the commands in the request fails all changes will be rolled back.
Paging for this symbol has been done, if this option is not set, the server will do the paging.
Deletes the given vector or map entry.
Validate the readValue against the symbol's JSON schema before
sending it to the client.
Replace the whole data structure instead of partially updating it.
When using vectors, add the entry at the end instead of replacing it.
Do not merge subscriptions.
Do not pass the symbol to the extension, simulate it instead.
For subscriptions only: Send a response for each subscription tick, even if the data has not changed.
Add error message and reason to the response. By default, only the error code is returned.
Send the writeValue for requests back to the client.
Represents how an can change.
Connected endpoint is permanently logged in.
Internal call.
Connected endpoint is a remote machine.
Connected endpoint is the local machine.
See: https://msdn.microsoft.com/en-us/library/office/ff604025(v=office.14).aspx
Critical
Error
Warning
Info
Verbose
Diagnostics
Temporary
Persistent