JsonObject Pascal Reference Documentation
JsonObject
Current Version: 11.5.0
Chilkat.JsonObject
Load JSON from strings, files, buffers, or Chilkat objects, then emit the
result as compact or pretty-formatted JSON.
Read and update nested values using JSON paths, with support for
automatically creating missing object or array paths.
Access object members by name or index, inspect member types, retrieve
values, and remove or rename members as needed.
Work directly with child
Search records, sort object members, perform Firebase-style updates, and
prepare JSON for API requests or application storage.
Handle date/time values, binary data encodings, exact numeric text,
variable substitution, and secure secret resolution.
For an extended overview, see
JsonObject Class Overview.
Load, navigate, create, modify, search, sort, and emit JSON objects.
Chilkat.JsonObject provides DOM-style access to JSON objects.
It can load, inspect, modify, create, search, sort, emit, and save JSON data.
It supports path-based access, index-based member access, automatic creation
of nested paths, object and array references, Firebase-style updates, record
searches, date/time conversion, binary data encoding, variable substitution,
and optional secure secret resolution.
Load and emit JSON
Path-based navigation
Member access
Nested objects and arrays
JsonObject and
JsonArray references to navigate and modify complex JSON
structures.
Search and transform
Special value handling
JsonObject, navigate named members and nested
paths, retrieve child arrays as JsonArray objects when ordered
lists are encountered, update values as needed, then emit or save the final
JSON. Use JsonObject for named JSON members and
JsonArray for ordered lists.
Create / Free
uses
Chilkat.JsonObject;
var
obj: TJsonObject;
begin
obj := TJsonObject.Create;
try
if not obj.IsValid then
raise Exception.Create('Failed to create a TJsonObject instance.');
// ... use obj ...
finally
obj.Free;
end;
end;
Allocates the underlying CkJsonObject object and returns a new TJsonObject instance. Simply adding Chilkat.JsonObject to the unit's uses clause is enough to locate and bind to the Chilkat shared library (DLL / .so / .dylib) at runtime — no separate load step is required. Check obj.IsValid after calling Create; it is False if the underlying library could not be found/loaded or the object could not be allocated (for example, when unlicensed).
Every TJsonObject created by calling Create should eventually be released by calling .Free (inherited from TObject). The destructor automatically disposes the underlying CkJsonObject handle. A native (unmanaged) memory leak occurs if the object is never freed.
Properties
DebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
DelimiterChar
Specifies the character used to separate object-member names in Chilkat JSON paths. The default is .. Set it to / for Firebase-style paths. This property should contain exactly one character.
orders[0].id. If a member name itself contains a path-separator character, quote that path component with double quotes.EmitCompact
Controls whether emitted JSON is compact or pretty-printed. The default is True.
| Emit a compact representation with no extra formatting whitespace. |
| Emit indented, human-readable JSON. |
EmitCrLf
Controls line endings when pretty-printed JSON is emitted (EmitCompact = ). The default is FalseTrue.
| Use CRLF line endings. |
| Use LF line endings. |
EmitCompact is True because compact JSON is emitted without formatting line breaks.EnableSecrets
Enables automatic resolution of Chilkat secret specification strings for supported string-setting methods. The default is False. When enabled, a value beginning with !! can identify a credential stored in Windows Credential Manager or Apple Keychain instead of embedding the literal secret in application code.
Secret specification format: !![appName|]service[|domain]|username.
This feature applies to AddStringAt, AppendString, SetStringAt, SetStringOf, UpdateSb, and UpdateString.
I
Supplies the integer substituted for i when a JSON path contains an array index such as [i]. This is useful for loop-based navigation without constructing a new path string for every iteration.
J and K properties provide the same substitution behavior for [j] and [k].J
Supplies the integer substituted for j when a JSON path contains [j]. It is commonly used with nested-array paths such as matrix[i][j].
K
Supplies the integer substituted for k when a JSON path contains [k]. It can be combined with I and J for deeper nested-array traversal.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LowerCaseNames
If True, member names are converted to lowercase while JSON is loaded by Load, LoadBd, LoadSb, or LoadFile. The default is False.
PathPrefix
Specifies a path prefix automatically prepended to JSON paths passed to path-based methods such as StringOf, ObjectOf, UpdateString, SetBoolOf, and SizeOfArray. The default is the empty string.
Size
Returns the number of direct name/value members in this JSON object. Nested members inside child objects are not included.
UncommonOptions
Provides a catch-all string for uncommon, implementation-specific options. The default is the empty string and it should normally remain empty.
JsonObject option is documented by Chilkat or provided by Chilkat support.VerboseLogging
If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AddArrayAt
const name: string): Boolean;
Inserts a new JSON array member named name at the zero-based member position index. The new array is empty.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AddArrayCopyAt
function AddArrayCopyAt(index: Integer;
const name: string;
jarr: TChilkatBase): Boolean;
Inserts a new JSON array member named name at the zero-based member position index. The array value is copied from jarr; subsequent changes to the source array do not modify the inserted copy.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AddBoolAt
const name: string;
value: Boolean): Boolean;
Inserts a new JSON boolean member named name at the zero-based member position index. The value is taken from value.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AddIntAt
const name: string;
value: Integer): Boolean;
Inserts a new JSON number member named name at the zero-based member position index. The integer value is emitted as a JSON number, not as a quoted string.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AddNullAt
const name: string): Boolean;
Inserts a new JSON null member named name at the zero-based member position index.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AddNumberAt
const name: string;
const numericStr: string): Boolean;
Inserts a new JSON number member named name at the zero-based member position index. The numericStr argument supplies the exact JSON numeric text to store.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.12345678901234567890, 1.2500, or scientific notation. The supplied text must be valid JSON number syntax; JSON does not permit NaN or infinity.Returns True for success, False for failure.
AddObjectAt
const name: string): Boolean;
Inserts a new JSON object member named name at the zero-based member position index. The new object is empty.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AddObjectCopyAt
function AddObjectCopyAt(index: Integer;
const name: string;
jsonObj: TChilkatBase): Boolean;
Inserts a new JSON object member named name at the zero-based member position index. The object value is copied from jsonObj; the inserted value is independent of the source.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AddStringAt
const name: string;
const value: string): Boolean;
Inserts a new JSON string member named name at the zero-based member position index. The value is stored as a JSON string and is escaped as needed when emitted.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns True for success, False for failure.
AppendArray
function AppendArray(const name: string): TChilkatBase;
Appends a new JSON array member named name to this object. The newly appended array is empty and the returned JsonArray references that array in this document, so changes made through it modify the same JSON tree.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns nil on failure
AppendArray2
function AppendArray2(const name: string;
jarr: TChilkatBase): Boolean;
Appends a new JSON array member named name to this object. A new empty array is created and jarr is updated to reference it. The method returns True on success.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
topAppendArrayCopy
function AppendArrayCopy(const name: string;
jarr: TChilkatBase): Boolean;
Appends a new JSON array member named name to this object. The array is copied from jarr, so the appended array is independent of the source array.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
AppendBool
value: Boolean): Boolean;
Appends a new JSON boolean member named name to this object. The value is taken from value.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
topAppendInt
value: Integer): Boolean;
Appends a new JSON number member named name to this object. The integer value is stored as a JSON number.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
topAppendObject
function AppendObject(const name: string): TChilkatBase;
Appends a new JSON object member named name to this object. The newly appended object is empty and the returned JsonObject references that object in this document.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns nil on failure
AppendObject2
function AppendObject2(const name: string;
jsonObj: TChilkatBase): Boolean;
Appends a new JSON object member named name to this object. A new empty object is created and jsonObj is updated to reference it. The method returns True on success.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
topAppendObjectCopy
function AppendObjectCopy(const name: string;
jsonObj: TChilkatBase): Boolean;
Appends a new JSON object member named name to this object. The object is copied from jsonObj, so the appended object is independent of the source object.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
AppendString
const value: string): Boolean;
Appends a new JSON string member named name to this object. The value is JSON-escaped as needed when emitted.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
topAppendStringArray
function AppendStringArray(const name: string;
values: TChilkatBase): Boolean;
Appends a new JSON array member named name to this object. The array is populated with the strings contained in values.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns True for success, False for failure.
ArrayAt
function ArrayAt(index: Integer): TChilkatBase;
Returns the JSON array stored in the member at zero-based position index. The returned JsonArray references the existing array in the same document; it is not a detached copy.
index must be an array. Use TypeAt when the member type is not already known.Returns nil on failure
ArrayAt2
function ArrayAt2(index: Integer;
jarr: TChilkatBase): Boolean;
Updates jarr to reference the JSON array stored at zero-based member position index and returns True on success.
Returns True for success, False for failure.
topArrayOf
function ArrayOf(const jsonPath: string): TChilkatBase;
Returns the JSON array at jsonPath. The returned JsonArray references the existing array in the same document, so modifications through it are reflected in the parent JSON.
orders[0].items.Returns nil on failure
ArrayOf2
function ArrayOf2(const jsonPath: string;
jarr: TChilkatBase): Boolean;
Updates jarr to reference the JSON array at jsonPath and returns True on success.
Returns True for success, False for failure.
topBoolAt
Returns the boolean value of the member at zero-based position index.
JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.BoolOf
Returns the boolean value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.
BytesOf
function BytesOf(const jsonPath: string;
const encoding: string;
bd: TChilkatBase): Boolean;
Reads the string value at jsonPath, decodes it using encoding (for example, base64 or hex), and appends the resulting bytes to bd.
encoding argument tells Chilkat how that text represents the original bytes.Returns True for success, False for failure.
Clear
Removes all members from this JSON object, leaving an empty object equivalent to {}.
CopyRef
function CopyRef(jsonObj: TChilkatBase): Boolean;
Updates jsonObj so that it references the same JSON object as the caller. No JSON data is copied.
Returns True for success, False for failure.
topDateOf
function DateOf(const jsonPath: string;
dateTime: TChilkatBase): Boolean;
Parses the date/time value at jsonPath and loads the result into dateTime. Recognized forms include ISO 8601 timestamps (for example, 2009-11-04T19:55:41Z), RFC 822-style date/time strings, and Unix timestamp integers.
CkDateTime.Returns True for success, False for failure.
Delete
Deletes the direct member named name from this JSON object.
name is a member name, not a JSON path. Use a path-based operation when deleting or replacing a nested value requires navigation first.Returns True for success, False for failure.
DeleteAt
Deletes the member at zero-based position index. Members after the deleted position shift toward the beginning.
Returns True for success, False for failure.
DeleteRecords
const relpath: string;
const value: string;
caseSensitive: Boolean): Integer;
Deletes every object record in the array at arrayPath whose value at relative path relpath equals or wildcard-matches value. The caseSensitive argument controls matching. Returns the number of records deleted.
DtOf
function DtOf(const jsonPath: string;
bLocal: Boolean;
dt: TChilkatBase): Boolean;
Parses the date/time value at jsonPath into dt. If bLocal is True, the destination receives local date/time fields; otherwise it receives UTC/GMT fields. Recognized inputs include ISO 8601 timestamps, RFC 822-style date/time strings, and Unix timestamp integers.
Returns True for success, False for failure.
Emit
Serializes the JSON document rooted at this object and returns the JSON text. Formatting is controlled by EmitCompact and, for pretty output, EmitCrLf.
Returns True for success, False for failure.
EmitBd
function EmitBd(bd: TChilkatBase): Boolean;
Serializes this JSON and appends the resulting bytes to bd.
BinData is preserved.Returns True for success, False for failure.
topEmitSb
function EmitSb(sb: TChilkatBase): Boolean;
Serializes this JSON and appends the resulting text to sb. Formatting follows EmitCompact and EmitCrLf.
StringBuilder is preserved; the emitted JSON is added after it.Returns True for success, False for failure.
topEmitWithSubs
function EmitWithSubs(subs: TChilkatBase;
omitEmpty: Boolean): string;
Serializes the JSON after substituting variables from subs into template strings. A placeholder such as {$name} is replaced by the corresponding hashtable value. Prefixing the variable name with i., as in {$i.count}, emits the substituted value as a JSON integer instead of a quoted string.
If omitEmpty is True, members whose substituted result is an empty string or empty array are omitted from the emitted JSON.
Predefine and LoadPredefined when the same JSON shape is emitted repeatedly with different values.Returns True for success, False for failure.
FindObjectWithMember
function FindObjectWithMember(const name: string): TChilkatBase;
Recursively searches this JSON subtree for the first JSON object containing a direct member named name. Returns that object, or nil if no matching object is found.
Returns nil on failure
FindObjectWithMember2
function FindObjectWithMember2(const name: string;
jsonObj: TChilkatBase): Boolean;
Recursively searches this JSON subtree for the first object containing a direct member named name. On success, jsonObj is updated to reference the matching object and the method returns True.
Returns True for success, False for failure.
topFindRecord
function FindRecord(const arrayPath: string;
const relPath: string;
const value: string;
caseSensitive: Boolean): TChilkatBase;
Searches the JSON array at arrayPath for the first object whose value at relative path relPath equals or wildcard-matches value. The caseSensitive argument controls string comparison. Returns the matching record object.
* to match zero or more characters. relPath is evaluated relative to each record object in the array.Returns nil on failure
FindRecord2
function FindRecord2(const arrayPath: string;
const relPath: string;
const value: string;
caseSensitive: Boolean;
jsonObj: TChilkatBase): Boolean;
Searches the JSON array at arrayPath using the same matching rules as FindRecord. On success, jsonObj is updated to reference the first matching record and the method returns True.
jsonObj modify that record.Returns True for success, False for failure.
topFindRecordString
const relPath: string;
const value: string;
caseSensitive: Boolean;
const retRelPath: string): string;
Searches the JSON array at arrayPath for the first record whose relPath value equals or wildcard-matches value, then returns the value at retRelPath from that same record as a string.
Name is Advertising and return its Id.” The * wildcard may be used in value.Returns True for success, False for failure.
FirebaseApplyEvent
const data: string): Boolean;
Applies a Firebase Realtime Database event to this JSON object. name should be put or patch, and data should contain event JSON such as {"path":"/","data":{"a":1,"b":2}}.
put replaces the value at a path, while patch updates individual child keys.Returns True for success, False for failure.
FirebasePatch
const jsonData: string): Boolean;
Applies Firebase-style patch semantics at jsonPath. jsonData must contain a JSON object; each key in that object updates or adds the corresponding key at the target path.
jsonPath is relative to this JsonObject.Returns True for success, False for failure.
FirebasePut
const value: string): Boolean;
Applies Firebase-style put semantics at jsonPath, replacing or inserting the value at that path. value is JSON text and may represent an object, array, number, boolean, null, or a quoted JSON string.
value must contain a valid JSON string literal, including its surrounding double quotes. Use UpdateString when you already have an ordinary application string.Returns True for success, False for failure.
GetDocRoot
function GetDocRoot: TChilkatBase;
Returns a JsonObject reference to the root object of the JSON document containing this object. This can be called from any nested object reference.
JsonObject references share the same underlying JSON document. The document remains available while at least one such reference is retained by the application.Returns nil on failure
GetDocRoot2
function GetDocRoot2(docRoot: TChilkatBase): Boolean;
Updates docRoot to reference the root object of the JSON document containing the caller and returns True on success.
Returns True for success, False for failure.
topHasMember
Returns True if a value exists at jsonPath; otherwise returns False.
null still exists. Use IsNullOf to test specifically for JSON null.Returns True for success, False for failure.
topIndexOf
Returns the zero-based position of the direct member named name, or -1 if that member name is not found.
name is searched only among the direct members of this object.IntAt
Returns the integer value of the member at zero-based position index.
JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.IntOf
Returns the integer value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.
StringOf or the exact numeric-text APIs when a JSON integer may exceed the range of the language binding's integer type.IsNullAt
Returns True if the member at zero-based position index has the JSON value null; otherwise returns False.
IsNullOf
Returns True if the value at jsonPath is the JSON literal null; otherwise returns False.
null is different from a missing member and from an empty string. Use HasMember when existence must be tested separately.JsonTypeOf
Returns an integer identifying the JSON type of the value at jsonPath. Returns -1 if no member exists at that path.
1 | string |
2 | number |
3 | object |
4 | array |
5 | boolean |
6 | null |
Load
Parses the JSON text in json and loads the parsed data into this object for DOM-style access and modification.
null, objects, or arrays. Object member names should be unique for interoperable JSON; RFC 8259 notes that consumers differ in how duplicate names are handled.Returns True for success, False for failure.
LoadBd
function LoadBd(bd: TChilkatBase): Boolean;
Parses JSON from the bytes contained in bd and loads it into this object.
Returns True for success, False for failure.
topLoadFile
Reads JSON text from the file at path, parses it, and loads the result into this object.
Returns True for success, False for failure.
LoadPredefined
Loads this object from the predefined JSON document identified by name. Predefined documents are created with Predefine.
Returns True for success, False for failure.
LoadSb
function LoadSb(sb: TChilkatBase): Boolean;
Parses JSON from the current contents of sb and loads it into this object.
Returns True for success, False for failure.
MakeCopy
function MakeCopy(json: TChilkatBase): Boolean;
Copies this JSON object into json. The destination receives an independent JSON copy rather than another reference to the same underlying object.
CopyRef when two JsonObject instances should refer to the same JSON object instead of duplicating its data.Returns True for success, False for failure.
topMoveMember
toIndex: Integer): Boolean;
Moves the direct member at zero-based position fromIndex to toIndex. Use toIndex = 0 to move it first or -1 to move it last.
Returns True for success, False for failure.
topNameAt
Returns the name of the member at zero-based position index. Use this with Size and TypeAt to iterate through an object's direct members.
Returns True for success, False for failure.
NewArrayOf
const jArr: string): Boolean;
Creates a JSON array at path and loads that array from the JSON text in jArr. The supplied text should represent a JSON array.
UpdateNewArray creates an empty array. NewArrayOf creates the array and immediately populates it from JSON text.Returns True for success, False for failure.
NewObjectOf
const jObj: string): Boolean;
Creates a JSON object at path and loads that object from the JSON text in jObj. The supplied text should represent a JSON object.
UpdateNewObject creates an empty object. NewObjectOf creates the object and immediately populates it from JSON text.Returns True for success, False for failure.
ObjectAt
function ObjectAt(index: Integer): TChilkatBase;
Returns the JSON object stored in the member at zero-based position index. The returned JsonObject references the existing child object in the same document; changes made through it modify that document.
index must be a JSON object. Use TypeAt when the type is not already known.Returns nil on failure
ObjectAt2
function ObjectAt2(index: Integer;
jsonObj: TChilkatBase): Boolean;
Updates jsonObj to reference the JSON object stored at zero-based member position index and returns True on success.
Returns True for success, False for failure.
topObjectOf
function ObjectOf(const jsonPath: string): TChilkatBase;
Returns the JSON object at jsonPath. The returned object is a live reference into the same JSON document, not a copy.
GetDocRoot when access must start from the document root.Returns nil on failure
ObjectOf2
function ObjectOf2(const jsonPath: string;
jsonObj: TChilkatBase): Boolean;
Updates jsonObj to reference the JSON object at jsonPath and returns True on success.
Returns True for success, False for failure.
topPredefine
Stores this JSON document in Chilkat's internal global collection of predefined JSON documents under name. If the name already exists, the predefined value is replaced.
JsonObject can load it by name with LoadPredefined.Returns True for success, False for failure.
Rename
const newName: string): Boolean;
Renames the direct member oldName to newName. The member value and its position are otherwise unchanged.
Returns True for success, False for failure.
RenameAt
const name: string): Boolean;
Renames the member at zero-based position index to name. The member value is not changed.
Returns True for success, False for failure.
SetBoolAt
value: Boolean): Boolean;
Sets the member at zero-based position index to a JSON boolean value.
Returns True for success, False for failure.
SetBoolOf
value: Boolean): Boolean;
Sets the value at jsonPath to a JSON boolean value.
UpdateBool when missing objects or array positions along the path should be created automatically.Returns True for success, False for failure.
SetIntAt
value: Integer): Boolean;
Sets the member at zero-based position index to a JSON number value. The integer is emitted as a JSON number.
Returns True for success, False for failure.
SetIntOf
value: Integer): Boolean;
Sets the value at jsonPath to an integer JSON number.
UpdateInt when missing objects or array positions along the path should be created automatically.Returns True for success, False for failure.
SetNullAt
Sets the member at zero-based position index to a JSON null value.
Returns True for success, False for failure.
SetNullOf
Sets the value at jsonPath to a JSON null value.
UpdateNull when missing objects or array positions along the path should be created automatically.Returns True for success, False for failure.
SetNumberAt
const value: string): Boolean;
Sets the member at zero-based position index to a JSON number value. The value argument is the exact textual representation of the JSON number.
NaN, and infinity are not valid JSON numbers.Returns True for success, False for failure.
SetNumberOf
const value: string): Boolean;
Sets the value at jsonPath to a JSON number value. The value argument supplies the exact textual form of the JSON number.
UpdateNumber when missing objects or array positions along the path should be created automatically.Returns True for success, False for failure.
SetStringAt
const value: string): Boolean;
Sets the member at zero-based position index to a JSON string value. The string is escaped as required when JSON is emitted.
Returns True for success, False for failure.
SetStringOf
const value: string): Boolean;
Sets the value at jsonPath to a JSON string value. The string is escaped as required when JSON is emitted.
UpdateString when missing objects or array positions along the path should be created automatically.Returns True for success, False for failure.
SizeOfArray
Returns the number of elements in the JSON array at jsonPath. Returns -1 if the path does not resolve to an existing JSON array.
Sort
caseSensitive: Boolean);
Sorts this object's direct members by member name. ascending selects ascending or descending order, and caseSensitive controls how names are compared.
StringAt
Returns the string value of the member at zero-based position index.
JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.StringOf can also provide textual representations of scalar JSON values such as numbers, booleans, and null; use the type-specific methods when the JSON type itself matters.Returns True for success, False for failure.
StringOf
Returns the value at jsonPath as text. For a JSON string, the string value is returned. Scalar non-string values such as numbers, booleans, and null are returned using their JSON textual representation.
JsonTypeOf, IntOf, BoolOf, or IsNullOf when the distinction between JSON types is important.Returns True for success, False for failure.
StringOfEquals
const value: string;
caseSensitive: Boolean): Boolean;
Returns True if the textual value at jsonPath equals value according to the caseSensitive setting; otherwise returns False.
StringOfSb
function StringOfSb(const jsonPath: string;
sb: TChilkatBase): Boolean;
Retrieves the value at jsonPath as text and appends it to sb.
StringBuilder are preserved.Returns True for success, False for failure.
topSwap
index2: Integer): Boolean;
Swaps the positions of the direct members at zero-based indexes index1 and index2. Member names and values are unchanged.
Returns True for success, False for failure.
TypeAt
Returns an integer identifying the JSON type of the member at zero-based position index. Returns -1 if no member exists at that index.
1 | string |
2 | number |
3 | object |
4 | array |
5 | boolean |
6 | null |
UIntOf
Returns the unsigned integer value at jsonPath.
UpdateBd
function UpdateBd(const jsonPath: string;
const encoding: string;
bd: TChilkatBase): Boolean;
Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The bytes in bd are first encoded according to encoding (for example, base64 or hex) and the encoded text is stored as the JSON string value.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns True for success, False for failure.
UpdateBool
value: Boolean): Boolean;
Updates the value at jsonPath to a JSON boolean value, or creates the member and any missing path components as needed.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns True for success, False for failure.
topUpdateInt
value: Integer): Boolean;
Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The integer value is stored as a JSON number.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns True for success, False for failure.
UpdateNewArray
Creates or replaces the value at jsonPath with a new empty JSON array. Missing path components are created automatically as needed.
Returns True for success, False for failure.
UpdateNewObject
Creates or replaces the value at jsonPath with a new empty JSON object. Missing path components are created automatically as needed.
Returns True for success, False for failure.
UpdateNull
Updates the value at jsonPath to a JSON null value, or creates the member and any missing path components as needed.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns True for success, False for failure.
topUpdateNumber
const numericStr: string): Boolean;
Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The numericStr argument is stored as the exact textual representation of the JSON number.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.UpdateNumber instead of UpdateInt for decimal/exponent forms, very large integers, or when preserving exact numeric text is important.Returns True for success, False for failure.
UpdateSb
function UpdateSb(const jsonPath: string;
sb: TChilkatBase): Boolean;
Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The new string value is taken from the contents of sb.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns True for success, False for failure.
topUpdateString
const value: string): Boolean;
Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The supplied string is JSON-escaped as needed.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns True for success, False for failure.
UpdateUInt
value: LongWord): Boolean;
Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The unsigned integer is stored as a JSON number.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns True for success, False for failure.
topWriteFile
Serializes this JSON and writes it to the file at path. Output formatting follows EmitCompact and EmitCrLf.
Returns True for success, False for failure.
top