System.JSON.TJSONValue.FindValue

• Up to Parent: TJSONValue

Delphi

function FindValue(const APath: string): TJSONValue;

C++

TJSONValue* __fastcall FindValue(const System::UnicodeString APath);

Properties

Type	Visibility	Source	Unit	Parent
function	public	System.JSON.pas System.JSON.hpp	System.JSON	TJSONValue

Description

Finds and returns a TJSONValue instance located at the specified APath JSON path. Otherwise, returns nil.

As implemented in the current TJSONValue version:

• If APath = '', FindValue returns this TJSONValue instance.
• Otherwise, FindValue returns nil.

Supported JSON Path Syntax

FindValue uses TJSONPathParser to parse the specified JSON path.

TJSONPathParser implements a subset of the JSON path specification defined by Stefan Göessner. Specifically, supported elements are:

• Child operators for objects:
  • Use . to access object properties that do not contain a dot in their name. For example, use root.child to access the child property of the root object.
  • Use [] to access object properties that do contain a quoting character in their name. For example, use root['child.name'] or root["child.name"] to access the child.name property of the root object.
• Subscript operator ([]) for arrays. For example, use root[0] to access the first item of the root array.

These operators do not support special expressions, they only support actual values (object properties or array indexes).

See Also

• System.JSON.TJSONArray.FindValue
• System.JSON.TJSONObject.FindValue