IResultObject

[ Schnittstelle ]

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>[];
}

Diese Schnittstelle erweitert TcHmi.IResultObject.

Enthält Informationen über den Erfolg der Anfrage und ggf. Rückgabewerte und weitere Informationen.

Der Server liefert bei allen Anfragen eine Rückmeldung über den Erfolg der Anfrage. Bei allen Requests sollte geprüft werden, ob dieser erfolgreich war. Siehe Beispiele bei request.

Eigenschaften

Name

Typ

Beschreibung

error

Errors

Fehlerursache

details [ Optional ]

Verfügbar ab Version 1.10

IErrorDetails

Optionale details zu error. Inhalt ist abhängig von der verwendeten Funktion und des Fehlers.

response [ Optional ]

Version 1.10

IMessage

Version 1.12

IMessage<W, R>

TwinCAT HMI Server Antwort Objekt.
Ab Version 1.12 kann der Typ der Daten im WriteValue und ReadValue der Commands per Typescript definiert sein. Hat ein Request Commands mit unterschiedlichen Typen, so kann dieser nicht spezifisch definiert werden (bleibt auf any).

results [ Optional ]

Verfügbar ab Version 1.12

IValueResultObject<R>[]

Rückgabewerte und ggf. Fehler-Details zu den einzelnen Symbolen aus der zu Grunde liegenden TwinCAT HMI Server Anfrage.

IResultObject 1:

Verfügbar ab Version 1.8