IResultObject

[ Interface ]

Version 1.10

export interface IResultObject extends TcHmi.IResultObject{
    response: IMessage;
};

Version 1.12

export interface IResultObject<W = any, R = W> extends TcHmi.IResultObject {
    response?: IMessage<W, R>;
    results?: IValueResultObject<R>[];
}

This interface extends TcHmi.IResultObject.

Contains information about the success of the request, and return values and other information, if applicable.

The server provides feedback on the success of all requests. You should check whether all requests were successful. See samples at request.

Properties

Name

Type

Description

error

Errors

Cause of the fault

details [ optional ]

Available since version 1.10

IErrorDetails

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

response [ optional ]

Version 1.10

IMessage

Version 1.12

IMessage<W, R>

TwinCAT HMI server response object.
From version 1.12 the data type in WriteValue and ReadValue of the Commands can be defined via typescript. If a request has Commands with different types, it cannot be defined specifically (remains set to any).

results [ optional ]

Available since version 1.12

IValueResultObject<R>[]

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

IResultObject 1:

Available from 1.8