ITcHmiSrvExtHost Interface

Provides an interface for a host to communicate with a TwinCAT HMI server.

Namespace:  TcHmiSrv
Assembly:  TcHmiSrvExtNet (in TcHmiSrvExtNet.dll) Version: 3.0.0.0

Syntax

C#

public interface ITcHmiSrvExtHost

The ITcHmiSrvExtHost type exposes the following members.

Methods

 

Name

Description

ITcHmiSrvExtHost Interface 1:

exec(Context, Command)

Executes a single Command in the domain of the specified Context.

ITcHmiSrvExtHost Interface 2:

exec(Context, CommandGroup)

Executes Commands inside any domain.

ITcHmiSrvExtHost Interface 3:

get_config_value

Gets the configuration Value at the specified path from the server.

ITcHmiSrvExtHost Interface 4:

localize

Localizes an ILocalizable object.

ITcHmiSrvExtHost Interface 5:

notify_listener

Sends a notification if an Alarm type changed.

ITcHmiSrvExtHost Interface 6:

register_listener(Context, ITcHmiSrvListener)

Registers an ITcHmiSrvListener at the server.

ITcHmiSrvExtHost Interface 7:

register_listener(Context, ITcHmiSrvListener, Value)

Registers an ITcHmiSrvListener at the server using the specified settings.

ITcHmiSrvExtHost Interface 8:

reset_temporary_events

Triggers a refresh of the list of events provided by an extension that implements the TcHmiSrvAlarmProviderListener.

ITcHmiSrvExtHost Interface 9:

send(Context, Event)

Adds or updates an Event.

ITcHmiSrvExtHost Interface 10:

send(Context, Message)

Adds a Message.

ITcHmiSrvExtHost Interface 11:

send(Context, Event, EventLifetime)

Adds or updates an Event.

ITcHmiSrvExtHost Interface 12:

send(Context, Message, EventLifetime)

Adds a Message.

ITcHmiSrvExtHost Interface 13:

set_config_value

Adds an entry to a map or vector in the extension configuration or updates an existing configuration Value.

ITcHmiSrvExtHost Interface 14:

unregister_listener(ITcHmiSrvListener)

Unregisters an ITcHmiSrvListener at the server.

ITcHmiSrvExtHost Interface 15:

unregister_listener(Context, ITcHmiSrvListener)

Unregisters an ITcHmiSrvListener at the server.

Reference

TcHmiSrv Namespace