CopyJsonStringFromSymbolProperties

CopyJsonStringFromSymbolProperties 1:

Diese Methode erzeugt eine entsprechende JSON-Repräsentation von SPS-Attributen an einem Symbol. Im Unterschied zur Methode AddJsonKeyPropertiesFromSymbol wird das Resultat nicht in eine Instanz vom Funktionsbaustein FB_JsonSaxWriter geschrieben, sondern in eine String-Variable. Als Eingangsparameter erhält die Methode den Datentypnamen des Symbols und eine String-Variable, welche eine durch Querbalken getrennte Liste der zu extrahierenden SPS‑Attribute darstellt.

Die Methode kopiert diese JSON-Repräsentation in eine Variable vom Datentyp STRING, welche eine beliebige Länge haben kann. Als Rückgabewert liefert die Methode die Länge des Strings (inklusive Nullterminierung). Falls der Zielpuffer zu klein ist, wird dieser durch eine Nullterminierung geleert und als Länge 0 zurückgegeben.

Syntax

METHOD CopyJsonStringFromSymbolProperties : UDINT
VAR_INPUT
  nDoc        : UDINT;
END_VAR
VAR_IN_OUT CONSTANT
  pDoc        : STRING;
  sDatatype   : STRING;
  sProperties : STRING;
END_VAR
VAR_OUTPUT
  hrErrorCode : HRESULT;
END_VAR

CopyJsonStringFromSymbolProperties 2: Rückgabewert

Name

Typ

CopyJsonStringFromSymbolProperties

UDINT

CopyJsonStringFromSymbolProperties 3: Eingänge

Name

Typ

nDoc

UDINT

CopyJsonStringFromSymbolProperties 4:/CopyJsonStringFromSymbolProperties 5: Ein-/Ausgänge

Name

Typ

pDoc

STRING

sDatatype

STRING

sProperties

STRING

CopyJsonStringFromSymbolProperties 6: Ausgänge

Name

Typ

hrErrorCode

HRESULT

Beispielaufruf:

nLen := fbJsonDataType.CopyJsonStringFromSymbolProperties('ST_Test','Unit|DisplayName',sString,SIZEOF(sString));