jsonGetString (Function)

jsonGetString reads a string from the provided JSON object or array.

When working on a JSON object, set the key parameter to the name of the value to get.

When working on a JSON array, idx must be set to the index of the element to get.

Input:

o : SYSHANDLE

A handle to the JSON array or object to work on.

idx : INT (Default -1)

Index to use when working on a JSON array.

key : STRING

The name of the value when working on a JSON object.

Output:

value : STRING

The value of the element.

Returns: INT

Declaration:

FUNCTION jsonGetString : INT;
VAR_INPUT
  o     : SYSHANDLE;
  idx   : INT := -1;
  key   : STRING;
  value : ACCESS STRING;
END_VAR;

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
VAR
  rc  : INT;
  str : STRING;
  arr : SYSHANDLE;
  obj : SYSHANDLE;
END_VAR;
 
BEGIN
  ...
  // Get object from array
  rc := jsonGetValue(o := arr, idx := 0, value := obj);
  // Get name from object
  rc := jsonGetString(o := obj, key := "Name", value := str);
  // Release object handle
  rc := jsonFree(o := obj);
  ...
END;
 
END_PROGRAM;