ITcHmiSrvExtHost Methods

The ITcHmiSrvExtHost type exposes the following members.

Methods

 

Name

Description

ITcHmiSrvExtHost Methods 1:

DeleteConfigValue

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

ITcHmiSrvExtHost Methods 2:

Execute(Context, Command)

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

ITcHmiSrvExtHost Methods 3:

Execute(Context, CommandGroup)

Executes the specified CommandGroup inside any domain.

ITcHmiSrvExtHost Methods 4:

GetConfigValue

Gets the configuration Value at the specified path.

ITcHmiSrvExtHost Methods 5:

Localize

Localizes an ILocalizable.

ITcHmiSrvExtHost Methods 6:

NotifyListener

Sends a notification if an Alarm has changed.

ITcHmiSrvExtHost Methods 7:

RegisterListener(Context, IListener)

Registers the specified IListener at the TwinCAT HMI server.

ITcHmiSrvExtHost Methods 8:

RegisterListener(Context, IListener, Value)

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

ITcHmiSrvExtHost Methods 9:

RemoveTemporaryEvent

Sends a notification if an Alarm should be removed.

ITcHmiSrvExtHost Methods 10:

RenameConfigValue

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

ITcHmiSrvExtHost Methods 11:

ReplaceConfigValue

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

ITcHmiSrvExtHost Methods 12:

ResetTemporaryEvents

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

ITcHmiSrvExtHost Methods 13:

Send(Context, Event)

Adds or updates an Event.

ITcHmiSrvExtHost Methods 14:

Send(Context, Message)

Adds a Message.

ITcHmiSrvExtHost Methods 15:

Send(Context, Event, EventLifetime)

Adds or updates an Event.

ITcHmiSrvExtHost Methods 16:

Send(Context, Message, EventLifetime)

Adds a Message.

ITcHmiSrvExtHost Methods 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 Methods 18:

UnregisterListener

Unregisters the specified IListener at the TwinCAT HMI server.

Reference

ITcHmiSrvExtHost Interface TcHmiSrv.Core Namespace

Copyright © Beckhoff Automation GmbH & Co. KG