IValueResultObject

[ Interface ]

export interface IValueResultObject<T = any> extends TcHmi.IResultObject {
    symbol?: string;
    value?: T;
}

This interface extends TcHmi.IResultObject.

Describes the return value plus error information for a specific symbol from a request to the TwinCAT HMI server, if applicable.

Properties

Name

Type

Description

error

Errors

Error code

details [ Optional ]

IErrorDetails

Optional details about error. Content depends on the function used and the error.

response

IMessage

TwinCAT HMI server response object.

results [ optional ]

IValueResultObject<R>[]

Return values and possibly error details for the individual symbols from the underlying TwinCAT HMI server request.

symbol [ optional ]

string

The name of the symbol.

value [ optional ]

any

The value of the symbol.

IValueResultObject 1:

Available from version 1.12