ITcHmiSrvExtHost Interface

ITcHmiSrvExtHost is obsolete. Use ITcHmiSrvExtAsyncHost instead.

Provides an interface to communicate with the TwinCAT HMI server.


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

Syntax

C#

[ObsoleteAttribute("ITcHmiSrvExtHost is obsolete. Use ITcHmiSrvExtAsyncHost instead.")]
public interface ITcHmiSrvExtHost

The ITcHmiSrvExtHost type exposes the following members.

Methods

 

Name

Description

ITcHmiSrvExtHost Interface 1:

DeleteConfigValue

Deletes a Value from the configuration of the TwinCAT HMI server extension.

ITcHmiSrvExtHost Interface 2:

Execute(Context, Command)

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

ITcHmiSrvExtHost Interface 3:

Execute(Context, CommandGroup)

Executes the specified CommandGroup inside any domain.

ITcHmiSrvExtHost Interface 4:

GetConfigValue

Gets the configuration Value at the specified path.

ITcHmiSrvExtHost Interface 5:

Localize

Localizes an ILocalizable.

ITcHmiSrvExtHost Interface 6:

NotifyListener

Sends a notification if an Alarm has changed.

ITcHmiSrvExtHost Interface 7:

RegisterListener(Context, IListener)

Registers the specified IListener at the TwinCAT HMI server.

ITcHmiSrvExtHost Interface 8:

RegisterListener(Context, IListener, Value)

Registers the specified IListener at the TwinCAT HMI server using the specified settings.

ITcHmiSrvExtHost Interface 9:

RemoveTemporaryEvent

Sends a notification if an Alarm should be removed.

ITcHmiSrvExtHost Interface 10:

RenameConfigValue

Renames a Value in the configuration of the TwinCAT HMI server extension.

ITcHmiSrvExtHost Interface 11:

ReplaceConfigValue

Replaces a Value in the configuration of the TwinCAT HMI server extension.

ITcHmiSrvExtHost Interface 12:

ResetTemporaryEvents

Triggers a refresh of the list of events provided by a TwinCAT HMI server extension that implements the AlarmProviderListener.

ITcHmiSrvExtHost Interface 13:

Send(Context, Event)

Adds or updates an Event.

ITcHmiSrvExtHost Interface 14:

Send(Context, Message)

Adds a Message.

ITcHmiSrvExtHost Interface 15:

Send(Context, Event, EventLifetime)

Adds or updates an Event.

ITcHmiSrvExtHost Interface 16:

Send(Context, Message, EventLifetime)

Adds a Message.

ITcHmiSrvExtHost Interface 17:

SetConfigValue

Tries to add a Value to a map or vector in the configuration of the TwinCAT HMI server extension or update an existing configuration Value. Since the configuration Value is set asynchronously, you cannot rely on the Value really being set after this method returned. Therefore, you must verify this by using OnChange or calling GetConfigValue(Context, String).
Obsolete

ITcHmiSrvExtHost Interface 18:

UnregisterListener

Unregisters the specified IListener at the TwinCAT HMI server.

Version Information

Obsolete (compiler warning) in 1.10.7447.0

Reference

TcHmiSrv.Core Namespace

Copyright © Beckhoff Automation GmbH & Co. KG