AddJsonKeyPropertiesFromSymbol

AddJsonKeyPropertiesFromSymbol 1:

Mit dieser Methode können Metadaten über SPS-Attribute in die JSON-Repräsentation einer SPS-Datenstruktur auf einem FB_JsonSaxWriter-Objekt hinzugefügt werden. Als Eingangsparameter erhält die Methode die Instanz des FB_JsonSaxWriter‑Funktionsbausteins, den gewünschten Namen des JSON-Properties, das die Metadaten enthalten soll, den Datentypnamen der Struktur und eine String-Variable sProperties, die eine durch einen Querbalken getrennte Liste der zu extrahierenden SPS-Attribute enthält.

Syntax

METHOD AddJsonValueFromSymbol : BOOL
VAR_IN_OUT
  fbWriter    : FB_JsonSaxWriter;
END_VAR
VAR_IN_OUT CONSTANT
  sKey        : STRING;
  sDatatype   : STRING;
  sProperties : STRING;
END_VAR
VAR_OUTPUT
  hrErrorCode : HRESULT;
END_VAR

AddJsonKeyPropertiesFromSymbol 2: Rückgabewert

Name

Typ

AddJsonValueFromSymbol

BOOL

AddJsonKeyPropertiesFromSymbol 3:/AddJsonKeyPropertiesFromSymbol 4: Ein-/Ausgänge

Name

Typ

fbWriter

FB_JsonSaxWriter

sKey

STRING

sDatatype

STRING

sProperties

STRING

AddJsonKeyPropertiesFromSymbol 5: Ausgänge

Name

Typ

hrErrorCode

HRESULT

Die SPS-Attribute können in folgender Form an den Strukturelementen spezifiziert werden:

{attribute 'Unit'        := 'm/s'}
{attribute 'DisplayName' := 'Speed'}
Sensor1                  : REAL;

Ein vollständiges Beispiel zur Verwendung dieser Methode finden Sie im Abschnitt Tc3JsonXmlSampleJsonDataType.

Beispielaufruf:

fbJsonSaxWriter.ResetDocument()
fbJsonDataType.AddJsonKeyPropertiesFromSymbol(fbJsonSaxWriter, 'MetaData','ST_Values','Unit|DisplayName');