ParseFromFileAsync (Methode)

Übersicht

Typ:

Methode

Verfügbar ab:

V1.5.4.0

Funktionsbeschreibung

Diese Methode wird zum asynchronen Analysieren einer JSON-formatierten Datei verwendet, die sich im Dateisystem der Steuerung befindet. Die Analyse kann mehrere Programmzyklen in Anspruch nehmen. Während der Analyse wird keine andere Methode oder Eigenschaft der Funktionsbausteininstanz verarbeitet. Die Anzahl der in einem Zyklus verarbeiteten Bytes wird durch den globalen Parameter GPL.Gc_udiJsonMaxNumOfBytesPerCycle bestimmt. Nach der erfolgreichen Ausführung der Methode wird das Stammelement ausgewählt.

Wenn ein Fehler erkannt wurde, verwenden Sie die Eigenschaften Result und ResultMsg, um das Ergebnis der Methode abzurufen.

Die Analyse ist abgeschlossen, wenn einer der Ausgänge q_xDone oder q_xError TRUE entspricht. Sie müssen die Methode zyklisch aufrufen, während der Ausgang q_xBusy TRUE ist.

Schnittstelle

Eingang

Datentyp

Beschreibung

i_sFilePath

STRING [255]

Der Pfad zur JSON-Datei, die gelesen werden soll.

Wenn ein Dateiname ohne Dateierweiterung angegeben wird, fügt der Funktionsbaustein die Erweiterung .json hinzu.

i_anyBuffer

ANY

Adresse der Variablen, die die JSON-formatierten Daten enthält, die in der Anwendung zugewiesen sind.

Variablen des Typs STRING oder ARRAY OF BYTE werden unterstützt.

i_sJPath

STRING [GPL.Gc_uiJsonMaxLengthOfJPath]

Ermöglicht die teilweise Analyse von JSON-formatierten Daten: Nur die Elemente auf der Unterhierarchieebene, wie das vom JPath-Ausdruck ausgewählte Element, werden analysiert.

Um die vollständigen Daten zu analysieren, weisen Sie eine Null-Zeichenfolge zu.

Siehe auch die Liste unterstützter JPath-Ausdrücke.

Ausgang

Datentyp

Beschreibung

q_xBusy

BOOL

Wenn dieser Ausgang auf TRUE gesetzt ist, wird die Methode ausgeführt.

q_xDone

BOOL

Wenn dieser Ausgang auf TRUE gesetzt ist, wurde die Methodenausführung erfolgreich abgeschlossen.

q_xError

BOOL

Wenn dieser Ausgang auf TRUE gesetzt wird, wurde ein Fehler identifiziert. Für weitere Informationen, siehe q_etResult und q_etResultMsg.

HINWEIS: Aus Leistungsgründen wird die Gültigkeit der Eingangsparameter der Funktionsbausteine nur im ersten Zyklus nach Auslösen der Methodenausführung geprüft. Ändern Sie diese Werte nicht, während die Analyse läuft. Durch die Ausführung dieser Methode werden ein zuvor erkannter und von den entsprechenden Eigenschaften angegebener Fehler sowie die Informationen zur vorhergehenden Analyseoperation zurückgesetzt. Der Funktionsbaustein führt eine grundlegende Basis-Syntaxprüfung der zu analysierenden Daten durch. Stellen Sie sicher, dass die Daten gemäß der JSON-Spezifikation formatiert wurden.