TChilkatJsonObject Delphi ActiveX Reference Documentation

TChilkatJsonObject

Current Version: 10.0.0

Represents a JSON object, which contains an unordered set of name/value pairs. Each value can be a string, number, JSON object, JSON array, true, false, or null.

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. See also: ActiveX Registration Tutorial
  3. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) should be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

Object Creation

var
obj: TChilkatJsonObject;
...
begin
obj := TChilkatJsonObject.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

DebugLogFilePath
property DebugLogFilePath: WideString

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples
Example showing how to use DebugLogFilePath.
top
DelimiterChar
property DelimiterChar: WideString
Introduced in version 9.5.0.58

Sets the delimiter char for JSON paths. The default value is ".". To use Firebase style paths, set this property to "/". (This is a string property that should have a length of 1 char.)

top
EmitCompact
property EmitCompact: Integer
Introduced in version 9.5.0.56

If 1 then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If 0, then emits with whitespace and indentation to make the JSON human-readable.

The default value is 1.

top
EmitCrLf
property EmitCrLf: Integer
Introduced in version 9.5.0.56

If 1 then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If 0, then bare-LF's are emitted. (The compact format emits to a single line with no end-of-line characters.) Windows systems traditionally use CRLF line-endings, whereas Linux, Mac OS X, and other systems traditionally use bare-LF line-endings.

The default value is 1.

top
I
property I: Integer
Introduced in version 9.5.0.56

The value of the "i" index to be used when evaluating a JSON path.

More Information and Examples
JSON Paths
top
J
property J: Integer
Introduced in version 9.5.0.56

The value of the "j" index to be used when evaluating a JSON path.

top
K
property K: Integer
Introduced in version 9.5.0.56

The value of the "k" index to be used when evaluating a JSON path.

top
LastBinaryResult
property LastBinaryResult: OleVariant readonly

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
property LastErrorHtml: WideString readonly

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
property LastErrorText: WideString readonly

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
property LastErrorXml: WideString readonly

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
property LastMethodSuccess: Integer

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
property LastStringResult: WideString readonly

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

More Information and Examples
Long Strings Returned by ActiveX Methods in SQL Server
top
LastStringResultLen
property LastStringResultLen: Integer readonly

The length, in characters, of the string contained in the LastStringResult property.

top
LowerCaseNames
property LowerCaseNames: Integer
Introduced in version 9.5.0.87

If 1 then all member names are converted to lowercase when the JSON is initially loaded by the following methods: Load, LoadBd, LoadSb, LoadFile.

The default value is 0.

top
PathPrefix
property PathPrefix: WideString
Introduced in version 9.5.0.76

A prefix string that is automatically added to the JSON path passed in the first argument for other methods (such as StringOf, UpdateString, SetBoolOf, SizeOfArray, etc.)

The default value is the empty string.

top
Size
property Size: Integer readonly
Introduced in version 9.5.0.56

The number of name/value members in this JSON object.

More Information and Examples
JSON Iterate Members
top
UncommonOptions
property UncommonOptions: WideString
Introduced in version 9.5.0.90

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

top
VerboseLogging
property VerboseLogging: Integer

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
property Version: WideString readonly

Version of the component/library, such as "9.5.0.94"

More Information and Examples
How to get the Chilkat version at runtime.
top

Methods

AddArrayAt
function AddArrayAt(index: Integer; name: WideString): Integer;
Introduced in version 9.5.0.56

Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Create more Complex JSON Document
top
AddArrayCopyAt
function AddArrayCopyAt(index: Integer; name: WideString; jarr: TChilkatJsonArray): Integer;
Introduced in version 9.5.0.82

Inserts a copy of a JSON array to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
JSON AddArrayCopyAt Example
top
AddBoolAt
function AddBoolAt(index: Integer; name: WideString; value: Integer): Integer;
Introduced in version 9.5.0.56

Inserts a new boolean member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
AddIntAt
function AddIntAt(index: Integer; name: WideString; value: Integer): Integer;
Introduced in version 9.5.0.56

Inserts a new integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Create JSON Document
top
AddNullAt
function AddNullAt(index: Integer; name: WideString): Integer;
Introduced in version 9.5.0.56

Inserts a new null member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
AddNumberAt
function AddNumberAt(index: Integer; name: WideString; numericStr: WideString): Integer;
Introduced in version 9.5.0.56

Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Create more Complex JSON Document
top
AddObjectAt
function AddObjectAt(index: Integer; name: WideString): Integer;
Introduced in version 9.5.0.56

Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Create more Complex JSON Document
top
AddObjectCopyAt
function AddObjectCopyAt(index: Integer; name: WideString; jsonObj: TChilkatJsonObject): Integer;
Introduced in version 9.5.0.82

Inserts a copy of a JSON object to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
JSON AddObjectCopyAt Example
top
AddStringAt
function AddStringAt(index: Integer; name: WideString; value: WideString): Integer;
Introduced in version 9.5.0.56

Inserts a new string member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Create JSON Document
top
AppendArray
function AppendArray(name: WideString): TChilkatJsonArray;
Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Important: The name is the member name, it is not a JSON path.

Returns nil on failure

More Information and Examples
JSON AppendArray Example
top
AppendArrayCopy
function AppendArrayCopy(name: WideString; jarr: TChilkatJsonArray): Integer;
Introduced in version 9.5.0.82

Appends a copy of a JSON array.

Important: The name is the member name, it is not a JSON path.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON AppendArrayCopy Example
top
AppendBool
function AppendBool(name: WideString; value: Integer): Integer;
Introduced in version 9.5.0.58

Appends a new boolean member. (This is the same as passing -1 to the AddBoolAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateBool instead.

Returns 1 for success, 0 for failure.

top
AppendInt
function AppendInt(name: WideString; value: Integer): Integer;
Introduced in version 9.5.0.58

Appends a new integer member. (This is the same as passing an index of -1 to the AddIntAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateInt instead.

Returns 1 for success, 0 for failure.

top
AppendObject
function AppendObject(name: WideString): TChilkatJsonObject;
Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Important: The name is the member name, it is not a JSON path.

Returns nil on failure

More Information and Examples
JSON AppendObject Example
top
AppendObjectCopy
function AppendObjectCopy(name: WideString; jsonObj: TChilkatJsonObject): Integer;
Introduced in version 9.5.0.82

Appends a copy of a JSON object.

Important: The name is the member name, it is not a JSON path.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON AppendObjectCopy Example
top
AppendString
function AppendString(name: WideString; value: WideString): Integer;
Introduced in version 9.5.0.58

Appends a new string member. (This is the same as passing -1 to the AddStringAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateString instead.

Returns 1 for success, 0 for failure.

top
AppendStringArray
function AppendStringArray(name: WideString; values: TChilkatStringTable): Integer;
Introduced in version 9.5.0.67

Appends an array of string values.

Important: The name is the member name, it is not a JSON path.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON Append String Array
top
ArrayAt
function ArrayAt(index: Integer): TChilkatJsonArray;
Introduced in version 9.5.0.56

Returns the JSON array that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns nil on failure

More Information and Examples
Create more Complex JSON Document
top
ArrayOf
function ArrayOf(jsonPath: WideString): TChilkatJsonArray;
Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns nil on failure

More Information and Examples
JSON: Access Array ValuesModify Parts of JSON DocumentJSON Paths
top
BoolAt
function BoolAt(index: Integer): Integer;
Introduced in version 9.5.0.56

Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

More Information and Examples
JSON: Miscellaneous Operations
top
BoolOf
function BoolOf(jsonPath: WideString): Integer;
Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
BytesOf
function BytesOf(jsonPath: WideString; encoding: WideString; bd: TChilkatBinData): Integer;
Introduced in version 9.5.0.68

Appends the binary bytes at the specified jsonPath to bd. The encoding indicates the encoding of the bytes, such as "base64", "hex", etc.

Returns 1 for success, 0 for failure.

More Information and Examples
Read/Write JSON with Binary Data such as JPEG Files
top
Clear
procedure Clear();
Introduced in version 9.5.0.76

Clears the contents of the JSON object. This is the equivalent of calling jsonObject.Load("{}")

top
Clone
function Clone(): TChilkatJsonObject;
Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns nil on failure

top
DateOf
function DateOf(jsonPath: WideString; dateTime: TCkDateTime): Integer;
Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located at jsonPath. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON Date ParsingParse a Microsoft JSON Date (MS AJAX Date)
top
Delete
function Delete(name: WideString): Integer;
Introduced in version 9.5.0.56

Deletes the member at having the name specified by name. Note: The name is not a tag path. It is the name of a member of this JSON object.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
DeleteAt
function DeleteAt(index: Integer): Integer;
Introduced in version 9.5.0.56

Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
DeleteRecords
function DeleteRecords(arrayPath: WideString; relpath: WideString; value: WideString; caseSensitive: Integer): Integer;
Introduced in version 9.5.0.88

Deletes JSON records in an array where a particular field equals or matches a value pattern. Returns the number of JSON records deleted.

top
DtOf
function DtOf(jsonPath: WideString; bLocal: Integer; dt: TDtObj): Integer;
Introduced in version 9.5.0.73

Fills the dt with the date/time string located at jsonPath. If bLocal is 1, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON Date Parsing
top
Emit
function Emit(): WideString;
Introduced in version 9.5.0.56

Writes the JSON document (rooted at the caller) and returns as a string.

Returns a zero-length WideString on failure

More Information and Examples
Pretty Print JSON (Formatter, Beautifier)
top
EmitBd
function EmitBd(bd: TChilkatBinData): Integer;
Introduced in version 9.5.0.77

Emits (appends) to the contents of bd.

Returns 1 for success, 0 for failure.

top
EmitSb
function EmitSb(sb: TChilkatStringBuilder): Integer;
Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns 1 for success, 0 for failure.

top
EmitWithSubs
function EmitWithSubs(subs: TChilkatHashtable; omitEmpty: Integer): WideString;
Introduced in version 9.5.0.67

Emits the JSON document with variable substitutions applied. If omitEmpty is 1, then members having empty strings or empty arrays are omitted.

Returns a zero-length WideString on failure

More Information and Examples
Using Pre-defined JSON Templates
top
FindObjectWithMember
function FindObjectWithMember(name: WideString): TChilkatJsonObject;
Introduced in version 9.5.0.67

Recursively searches the JSON subtree rooted at the caller's node for a JSON object containing a member having a specified name. (If the caller is the root node of the entire JSON document, then the entire JSON document is searched.) Returns the first match or nil if not found.

Returns nil on failure

top
FindRecord
function FindRecord(arrayPath: WideString; relPath: WideString; value: WideString; caseSensitive: Integer): TChilkatJsonObject;
Introduced in version 9.5.0.63

Finds a JSON record in an array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns nil on failure

More Information and Examples
JSON FindRecord Example
top
FindRecordString
function FindRecordString(arrayPath: WideString; relPath: WideString; value: WideString; caseSensitive: Integer; retRelPath: WideString): WideString;
Introduced in version 9.5.0.63

Finds a JSON value in an record array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns a zero-length WideString on failure

More Information and Examples
JSON FindRecordString Example
top
FirebaseApplyEvent
function FirebaseApplyEvent(name: WideString; data: WideString): Integer;
Introduced in version 9.5.0.58

Applies a Firebase event to the JSON. The data contains JSON having a format such as 

{"path": "/", "data": {"a": 1, "b": 2}}
The name should be "put" or "patch".

Returns 1 for success, 0 for failure.

More Information and Examples
Firebase Receive Server-Sent Events (text/event-stream)
top
FirebasePatch
function FirebasePatch(jsonPath: WideString; jsonData: WideString): Integer;
Introduced in version 9.5.0.58

For each key in the jsonData, update (or add) the corresponding key in the JSON at the given jsonPath. The jsonPath is relative to this JSON object. (This is effectively applying a Firebase patch event.)

Returns 1 for success, 0 for failure.

More Information and Examples
Firebase JSON Put and Patch
top
FirebasePut
function FirebasePut(jsonPath: WideString; value: WideString): Integer;
Introduced in version 9.5.0.58

Inserts or replaces the value at the jsonPath. The value can contain JSON text, an integer (in decimal string format), a boolean (true/false), the keyword "null", or a quoted string.

The jsonPath is relative to this JSON object. (This is effectively applying a Firebase put event.)

Returns 1 for success, 0 for failure.

More Information and Examples
Firebase JSON Put and Patch
top
GetDocRoot
function GetDocRoot(): TChilkatJsonObject;
Introduced in version 9.5.0.56

Returns the root of the JSON document. The root can be obtained from any JSON object within the JSON document. The entire JSON document remains in memory as long as at least one JSON object is referenced by the application. When the last reference is removed, the entire JSON document is automatically dellocated.

Returns nil on failure

More Information and Examples
Get the Root of a JSON Document
top
HasMember
function HasMember(jsonPath: WideString): Integer;
Introduced in version 9.5.0.58

Returns 1 if the item at the jsonPath exists.

Returns 1 for success, 0 for failure.

top
IndexOf
function IndexOf(name: WideString): Integer;
Introduced in version 9.5.0.56

Returns the index of the member having the given name. Returns -1 if the name is not found.

More Information and Examples
Get the Index of a JSON Member
top
IntAt
function IntAt(index: Integer): Integer;
Introduced in version 9.5.0.56

Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

More Information and Examples
JSON Iterate Members
top
IntOf
function IntOf(jsonPath: WideString): Integer;
Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

More Information and Examples
JSON: Miscellaneous OperationsJSON PathsCheck if Integer Exists at JSON PathDemonstrates how to Handle Large Integers in JSON
top
IsNullAt
function IsNullAt(index: Integer): Integer;
Introduced in version 9.5.0.56

Returns the boolean value of the member having the specified index.

More Information and Examples
JSON: Miscellaneous Operations
top
IsNullOf
function IsNullOf(jsonPath: WideString): Integer;
Introduced in version 9.5.0.56

Returns 1 if the value at the specified jsonPath is null. Otherwise returns 0.

More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
JsonTypeOf
function JsonTypeOf(jsonPath: WideString): Integer;
Introduced in version 9.5.0.68

Returns the type of data at the given jsonPath. Possible return values are:

  1. 1 - string
  2. 2- number
  3. 3- object
  4. 4- array
  5. 5- boolean
  6. 6- null
Returns -1 if no member exists at the given jsonPath.

top
Load
function Load(json: WideString): Integer;
Introduced in version 9.5.0.56

Parses a JSON string and loads it into this JSON object to provide DOM-style access.

Returns 1 for success, 0 for failure.

More Information and Examples
Load JSON Data at PathLoad a JSON ArrayLoading and Parsing a JSON ArrayUnderstanding JSON Array vs JSON Object
top
LoadBd
function LoadBd(bd: TChilkatBinData): Integer;
Introduced in version 9.5.0.77

Loads the contents of bd.

Returns 1 for success, 0 for failure.

top
LoadFile
function LoadFile(path: WideString): Integer;
Introduced in version 9.5.0.56

Loads a JSON file into this JSON object. The path is the file path to the JSON file.

Returns 1 for success, 0 for failure.

More Information and Examples
Load a JSON Array
top
LoadPredefined
function LoadPredefined(name: WideString): Integer;
Introduced in version 9.5.0.67

Loads this JSON object from a predefined document having a specified name.

Returns 1 for success, 0 for failure.

More Information and Examples
Using Pre-defined JSON Templates
top
LoadSb
function LoadSb(sb: TChilkatStringBuilder): Integer;
Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns 1 for success, 0 for failure.

More Information and Examples
Download a Specific GMail Message into a Chilkat Email Object
top
MoveMember
function MoveMember(fromIndex: Integer; toIndex: Integer): Integer;
Introduced in version 9.5.0.80

Move the member from fromIndex to toIndex. If toIndex equals -1, then moves the member at position fromIndex to the last position. Set toIndex = 0 to move a member to the first position.

Returns 1 for success, 0 for failure.

top
NameAt
function NameAt(index: Integer): WideString;
Introduced in version 9.5.0.56

Returns the name of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns a zero-length WideString on failure

More Information and Examples
JSON Iterate Members
top
ObjectAt
function ObjectAt(index: Integer): TChilkatJsonObject;
Introduced in version 9.5.0.56

Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns nil on failure

More Information and Examples
Create more Complex JSON Document
top
ObjectOf
function ObjectOf(jsonPath: WideString): TChilkatJsonObject;
Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns nil on failure

More Information and Examples
JSON: Nested ObjectsJSON Paths
top
Predefine
function Predefine(name: WideString): Integer;
Introduced in version 9.5.0.67

Adds or replaces this JSON to an internal global set of predefined JSON documents that can be subsequently loaded by name.

Returns 1 for success, 0 for failure.

More Information and Examples
Using Pre-defined JSON Templates
top
Rename
function Rename(oldName: WideString; newName: WideString): Integer;
Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
RenameAt
function RenameAt(index: Integer; name: WideString): Integer;
Introduced in version 9.5.0.56

Renames the member at index to name.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Renaming and Deleting Members
top
SetBoolAt
function SetBoolAt(index: Integer; value: Integer): Integer;
Introduced in version 9.5.0.56

Sets the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Modify Parts of JSON Document
top
SetBoolOf
function SetBoolOf(jsonPath: WideString; value: Integer): Integer;
Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns 1 for success, 0 for failure.

More Information and Examples
Modify Parts of JSON DocumentJSON Paths
top
SetIntAt
function SetIntAt(index: Integer; value: Integer): Integer;
Introduced in version 9.5.0.56

Sets the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Modify Parts of JSON Document
top
SetIntOf
function SetIntOf(jsonPath: WideString; value: Integer): Integer;
Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns 1 for success, 0 for failure.

More Information and Examples
Modify Parts of JSON DocumentJSON Paths
top
SetNullAt
function SetNullAt(index: Integer): Integer;
Introduced in version 9.5.0.56

Sets the value of the Nth member to null. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
SetNullOf
function SetNullOf(jsonPath: WideString): Integer;
Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
SetNumberAt
function SetNumberAt(index: Integer; value: WideString): Integer;
Introduced in version 9.5.0.56

Sets the numeric value of the Nth member. The value is an integer, float, or double already converted to a string in the format desired by the application. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Miscellaneous Operations
top
SetNumberOf
function SetNumberOf(jsonPath: WideString; value: WideString): Integer;
Introduced in version 9.5.0.56

Sets the numeric value at the specified jsonPath. The value is an integer, float, or double already converted to a string in the format desired by the application.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON: Miscellaneous OperationsJSON Paths
top
SetStringAt
function SetStringAt(index: Integer; value: WideString): Integer;
Introduced in version 9.5.0.56

Sets the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

More Information and Examples
Modify Parts of JSON Document
top
SetStringOf
function SetStringOf(jsonPath: WideString; value: WideString): Integer;
Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns 1 for success, 0 for failure.

More Information and Examples
Modify Parts of JSON DocumentJSON Paths
top
SizeOfArray
function SizeOfArray(jsonPath: WideString): Integer;
Introduced in version 9.5.0.56

Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.

More Information and Examples
JSON Paths
top
Sort
procedure Sort(ascending: Integer; caseSensitive: Integer);
Introduced in version 9.5.0.100

Sorts the JSON members by the member name.

More Information and Examples
Sort JSON Object by Member Key Name
top
StringAt
function StringAt(index: Integer): WideString;
Introduced in version 9.5.0.56

Returns the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns a zero-length WideString on failure

More Information and Examples
JSON Iterate Members
top
StringOf
function StringOf(jsonPath: WideString): WideString;
Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns a zero-length WideString on failure

More Information and Examples
JSON: Miscellaneous OperationsJSON PathsJSON Paths that need Double Quotes
top
StringOfEquals
function StringOfEquals(jsonPath: WideString; value: WideString; caseSensitive: Integer): Integer;
Introduced in version 9.5.0.96

Returns 1 if the string value at the specified jsonPath equals value. Otherwise returns 0

top
StringOfSb
function StringOfSb(jsonPath: WideString; sb: TChilkatStringBuilder): Integer;
Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns 1 for success, 0 for failure.

top
Swap
function Swap(index1: Integer; index2: Integer): Integer;
Introduced in version 9.5.0.76

Swaps the positions of members at index1 and index2.

Returns 1 for success, 0 for failure.

More Information and Examples
Swap JSON Objects
top
TypeAt
function TypeAt(index: Integer): Integer;
Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

  1. string
  2. number
  3. object
  4. array
  5. boolean
  6. null
Returns -1 if no member exists at the given index.

top
UIntOf
function UIntOf(jsonPath: WideString): Integer;
Introduced in version 9.5.0.96

Returns the unsigned integer at the specified jsonPath.

top
UpdateBd
function UpdateBd(jsonPath: WideString; encoding: WideString; bd: TChilkatBinData): Integer;
Introduced in version 9.5.0.68

Updates or appends a new string member with the encoded contents of bd. If the full path specified by jsonPath does not exist, it is automatically created as needed. The bytes contained in bd are encoded according to encoding (such as "base64", "hex", etc.)

Returns 1 for success, 0 for failure.

More Information and Examples
Read/Write JSON with Binary Data such as JPEG Files
top
UpdateBool
function UpdateBool(jsonPath: WideString; value: Integer): Integer;
Introduced in version 9.5.0.63

Updates or appends a new boolean member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

top
UpdateInt
function UpdateInt(jsonPath: WideString; value: Integer): Integer;
Introduced in version 9.5.0.63

Updates or appends a new integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON UpdateNumber vs UpdateInt
top
UpdateNewArray
function UpdateNewArray(jsonPath: WideString): Integer;
Introduced in version 9.5.0.75

Updates or appends a new and empty array at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON Insert Empty Array or Object
top
UpdateNewObject
function UpdateNewObject(jsonPath: WideString): Integer;
Introduced in version 9.5.0.75

Updates or appends a new and empty JSON object at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON Insert Empty Array or Object
top
UpdateNull
function UpdateNull(jsonPath: WideString): Integer;
Introduced in version 9.5.0.65

Updates or appends a null member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

top
UpdateNumber
function UpdateNumber(jsonPath: WideString; numericStr: WideString): Integer;
Introduced in version 9.5.0.65

Updates or appends a new numeric member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON UpdateNumber vs UpdateInt
top
UpdateSb
function UpdateSb(jsonPath: WideString; sb: TChilkatStringBuilder): Integer;
Introduced in version 9.5.0.68

Updates or appends a new string member with the contents of sb. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

top
UpdateString
function UpdateString(jsonPath: WideString; value: WideString): Integer;
Introduced in version 9.5.0.63

Updates or appends a new string member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Important: Prior to version 9.5.0.68, the string passed in to this method did not get properly JSON escaped. This could cause problems if non-us-ascii chars are present, or if certain special chars such as quotes, CR's, or LF's are present. Version 9.5.0.68 fixes the problem.

Returns 1 for success, 0 for failure.

More Information and Examples
JSON UpdateString
top
UpdateUInt
function UpdateUInt(jsonPath: WideString; value: Integer): Integer;
Introduced in version 9.5.0.96

Updates or appends a new unsigned integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns 1 for success, 0 for failure.

top
WriteFile
function WriteFile(path: WideString): Integer;
Introduced in version 9.5.0.76

Saves the JSON to a file.

Returns 1 for success, 0 for failure.

top