ST_IotFunctionsMessage

Contains detailed information about the underlying message object.

Syntax

(* request Id of governing request containing this message *)
nRequestId            : ULINT;

(* cycle in which this message was created *)
nCycleCreated         : ULINT;

(* time passed since creation (in milliseconds) *)
nAge                  : ULINT;

(* corresponding IoTDataAgent channel *)
nChannelId            : UDINT;

(* hrResult of latest action *)
hrResultCode          : HRESULT;

(* message Id *)
nMessageId            : UINT;

(* amount of initiated Ads requests during message lifetime *)
nAdsRequestCount      : UINT;

(* amount of received Ads confirmations during message lifetime *)
nAdsConfirmationCount : UINT;

(* current (internal) state of message object. *)
eMessageState         : EIotFunctionsMessageState;

(* message direction [read/write] *)
eMessageDirection     : EIotFunctionsMessageDirection;

(* indicates if the accepted data differes from the previously contained data (relevant for reading data) *)
bBufferChanged        : BOOL;

(* name of the corresponding symbol *)
sSymbolName           : STRING(255);

Parameter

Name

Type

Description

nRequestId

ULINT

ID of the request containing this message.

nCycleCreated

ULINT

Cycle in which this message was created.

nAge

ULINT

Elapsed time since this message was created in milliseconds.

nChannelId

UDINT

ID of the channel to be used in the Data Agent.

hrResultCode

HRESULT

HRESULT of the last operation performed.

nMessageId

UINT

ID of this message.

nAdsRequestCount

UINT

Number of ADS operations during the lifetime of this message (ADS requests).

nAdsConfirmationCount

UINT

Number of ADS operations during the lifetime of this message (ADS confirmations).

eMessageState

EIotFunctionsMessageState

Current internal state of this message object.

eMessageDirection

EIotFunctionsMessageDirection

Direction of this message (read or write).

bBufferChanged

BOOL

Indicates whether the content of the message buffer has changed (relevant for read operations).

sSymbolName

STRING

Name of the symbol used.