ITcHmiSrvExtAsyncHost.SendAsync Method (Context, Event, EventLifetime)

Adds or updates an Event as an asynchronous operation.

Namespace:  TcHmiSrv.Core
Assembly:  TcHmiSrvExtNet.Core (in TcHmiSrvExtNet.Core.dll) Version: 1.3.0.0

Syntax

C#

Task<(ErrorValue , Event )> SendAsync(
    Context context,
    Event e,
    EventLifetime lifetime
)

Parameters

context

Type: TcHmiSrv.Core.Context
The Context under which the e should be sent.

e

Type: TcHmiSrv.Core.Event
The Event to send to the TwinCAT HMI server and all current IListeners. When this method returns, the Payload may have been localized if it can be converted to ILocalizable.

lifetime

Type: TcHmiSrv.Core.EventLifetime
Specifies whether the Event is stored persistently.

Return Value

Type: Task.ValueTuple.ErrorValue, Event..
A Task.TResult. that represents the asynchronous operation. The Result of the Task.TResult. returns a ValueTuple.T1, T2. containing HMI_SUCCESS if sending the Event succeeded and the sent Event; otherwise any ErrorValue that best describes which error has occurred.

Reference

ITcHmiSrvExtAsyncHost Interface

SendAsync Overload

TcHmiSrv.Core Namespace