ITcHmiSrvExtAsyncHost Methods

The ITcHmiSrvExtAsyncHost type exposes the following members.

Methods

 

Name

Description

ITcHmiSrvExtAsyncHost Methods 1:

DeleteConfigValue

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

ITcHmiSrvExtAsyncHost Methods 2:

DeleteConfigValueAsync

Deletes a Value from the configuration of the TwinCAT HMI server extension as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 3:

Execute(Context, Command)

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

ITcHmiSrvExtAsyncHost Methods 4:

Execute(Context, CommandGroup)

Executes the specified CommandGroup inside any domain.

ITcHmiSrvExtAsyncHost Methods 5:

ExecuteAsync(Context, Command)

Executes a single Command in the domain of the specified Context as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 6:

ExecuteAsync(Context, CommandGroup)

Executes the specified CommandGroup inside any domain as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 7:

GetConfigValue

Gets the configuration Value at the specified path.

ITcHmiSrvExtAsyncHost Methods 8:

GetConfigValueAsync

Gets the configuration Value at the specified path as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 9:

Localize

Localizes an ILocalizable.

ITcHmiSrvExtAsyncHost Methods 10:

LocalizeAsync

Localizes an ILocalizable as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 11:

NotifyListener

Sends a notification if an Alarm has changed.

ITcHmiSrvExtAsyncHost Methods 12:

NotifyListenerAsync

Sends a notification if an Alarm has changed as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 13:

RegisterListener(Context, IListener)

Registers the specified IListener at the TwinCAT HMI server.

ITcHmiSrvExtAsyncHost Methods 14:

RegisterListener(Context, String, IListener)

Registers the specified IListener at the TwinCAT HMI server for the specified domain.

ITcHmiSrvExtAsyncHost Methods 15:

RegisterListener(Context, IListener, Value)

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

ITcHmiSrvExtAsyncHost Methods 16:

RegisterListener(Context, String, IListener, Value)

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

ITcHmiSrvExtAsyncHost Methods 17:

RegisterListenerAsync(Context, IListener)

Registers the specified IListener at the TwinCAT HMI server as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 18:

RegisterListenerAsync(Context, String, IListener)

Registers the specified IListener at the TwinCAT HMI server for the specified domain as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 19:

RegisterListenerAsync(Context, IListener, Value)

Registers the specified IListener at the TwinCAT HMI server using the specified settings as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 20:

RegisterListenerAsync(Context, String, IListener, Value)

Registers the specified IListener at the TwinCAT HMI server for the specified domain using the specified settings as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 21:

RemoveTemporaryEvent

Sends a notification if an Alarm should be removed.

ITcHmiSrvExtAsyncHost Methods 22:

RemoveTemporaryEventAsync

Sends a notification if an Alarm should be removed as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 23:

RenameConfigValue

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

ITcHmiSrvExtAsyncHost Methods 24:

RenameConfigValueAsync

Renames a Value in the configuration of the TwinCAT HMI server extension as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 25:

ReplaceConfigValue

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

ITcHmiSrvExtAsyncHost Methods 26:

ReplaceConfigValueAsync

Replaces a Value in the configuration of the TwinCAT HMI server extension as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 27:

ResetTemporaryEvents

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

ITcHmiSrvExtAsyncHost Methods 28:

ResetTemporaryEventsAsync

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

ITcHmiSrvExtAsyncHost Methods 29:

Send(Context, Event)

Adds or updates an Event.

ITcHmiSrvExtAsyncHost Methods 30:

Send(Context, Message)

Adds a Message.

ITcHmiSrvExtAsyncHost Methods 31:

Send(Context, Event, EventLifetime)

Adds or updates an Event.

ITcHmiSrvExtAsyncHost Methods 32:

Send(Context, Message, EventLifetime)

Adds a Message.

ITcHmiSrvExtAsyncHost Methods 33:

SendAsync(Context, Event)

Adds or updates an Event as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 34:

SendAsync(Context, Message)

Adds a Message as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 35:

SendAsync(Context, Event, EventLifetime)

Adds or updates an Event as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 36:

SendAsync(Context, Message, EventLifetime)

Adds a Message as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 37:

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

ITcHmiSrvExtAsyncHost Methods 38:

SetConfigValueAsync

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 as an asynchronous operation. 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 GetConfigValueAsync(Context, String).
Obsolete

ITcHmiSrvExtAsyncHost Methods 39:

SetFriendlyName

Changes the friendly name of a TwinCAT HMI server extension.

ITcHmiSrvExtAsyncHost Methods 40:

SetFriendlyNameAsync

Changes the friendly name of a TwinCAT HMI server extension as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 41:

TryLocalize

Tries to localize an ILocalizable.

ITcHmiSrvExtAsyncHost Methods 42:

TryLocalizeAsync

Tries to localize an ILocalizable as an asynchronous operation.

ITcHmiSrvExtAsyncHost Methods 43:

UnregisterListener

Unregisters the specified IListener at the TwinCAT HMI server. All registered IListeners are unregistered automatically when the extension is shut down.

ITcHmiSrvExtAsyncHost Methods 44:

UnregisterListenerAsync

Unregisters the specified IListener at the TwinCAT HMI server as an asynchronous operation. All registered IListeners are unregistered automatically when the extension is shut down.

Reference

ITcHmiSrvExtAsyncHost Interface TcHmiSrv.Core Namespace

Copyright © Beckhoff Automation GmbH & Co. KG