JsonObject ActiveX Reference Documentation

JsonObject

Current Version: 9.5.0.73

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.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatJsonObject

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.JsonObject")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.JsonObject")

(Delphi)
obj := TChilkatJsonObject.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.JsonObject')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.JsonObject");

Properties

DebugLogFilePath
DebugLogFilePath As String

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.

top
DelimiterChar
DelimiterChar As String
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
EmitCompact As Long
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
EmitCrLf As Long
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
I As Long
Introduced in version 9.5.0.56

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

top
J
J As Long
Introduced in version 9.5.0.56

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

top
K
K As Long
Introduced in version 9.5.0.56

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

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

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
LastErrorHtml As String (read-only)

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
LastErrorText As String (read-only)

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.

top
LastErrorXml
LastErrorXml As String (read-only)

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
LastMethodSuccess As Long
Introduced in version 9.5.0.52

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
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

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).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

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

top
Size
Size As Long (read-only)
Introduced in version 9.5.0.56

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

top
VerboseLogging
VerboseLogging As Long

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
Version As String (read-only)

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

top

Methods

AddArrayAt
AddArrayAt(ByVal index As Long, name As String) As Long
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.

top
AddBoolAt
AddBoolAt(ByVal index As Long, name As String, ByVal value As Long) As Long
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.

top
AddIntAt
AddIntAt(ByVal index As Long, name As String, ByVal value As Long) As Long
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.

top
AddNullAt
AddNullAt(ByVal index As Long, name As String) As Long
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.

top
AddNumberAt
AddNumberAt(ByVal index As Long, name As String, numericStr As String) As Long
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.

top
AddObjectAt
AddObjectAt(ByVal index As Long, name As String) As Long
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.

top
AddStringAt
AddStringAt(ByVal index As Long, name As String, value As String) As Long
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.

top
AppendArray
AppendArray(name As String) As ChilkatJsonArray
Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Returns Nothing on failure

top
AppendBool
AppendBool(name As String, ByVal value As Long) As Long
Introduced in version 9.5.0.58

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

Returns 1 for success, 0 for failure.

top
AppendInt
AppendInt(name As String, ByVal value As Long) As Long
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.)

Returns 1 for success, 0 for failure.

top
AppendObject
AppendObject(name As String) As ChilkatJsonObject
Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Returns Nothing on failure

top
AppendString
AppendString(name As String, value As String) As Long
Introduced in version 9.5.0.58

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

Returns 1 for success, 0 for failure.

top
AppendStringArray
AppendStringArray(name As String, values As ChilkatStringTable) As Long
Introduced in version 9.5.0.67

Appends an array of string values.

Returns 1 for success, 0 for failure.

top
ArrayAt
ArrayAt(ByVal index As Long) As ChilkatJsonArray
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 Nothing on failure

top
ArrayOf
ArrayOf(jsonPath As String) As ChilkatJsonArray
Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns Nothing on failure

top
BoolAt
BoolAt(ByVal index As Long) As Long
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).

top
BoolOf
BoolOf(jsonPath As String) As Long
Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

top
BytesOf
BytesOf(jsonPath As String, encoding As String, bd As ChilkatBinData) As Long
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.

top
Clone
Clone() As ChilkatJsonObject
Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns Nothing on failure

top
DateOf
DateOf(jsonPath As String, dateTime As CkDateTime) As Long
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.

top
Delete
Delete(name As String) As Long
Introduced in version 9.5.0.56

Deletes the member at having the name specified by name.

Returns 1 for success, 0 for failure.

top
DeleteAt
DeleteAt(ByVal index As Long) As Long
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.

top
DtOf
DtOf(jsonPath As String, ByVal bLocal As Long, dt As DtObj) As Long
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.

top
Emit
Emit() As String
Introduced in version 9.5.0.56

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

Returns Nothing on failure

top
EmitSb
EmitSb(sb As ChilkatStringBuilder) As Long
Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns 1 for success, 0 for failure.

top
EmitWithSubs
EmitWithSubs(subs As ChilkatHashtable, ByVal omitEmpty As Long) As String
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 Nothing on failure

top
FindObjectWithMember
FindObjectWithMember(name As String) As ChilkatJsonObject
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 Nothing if not found.

Returns Nothing on failure

top
FindRecord
FindRecord(arrayPath As String, relPath As String, value As String, ByVal caseSensitive As Long) As ChilkatJsonObject
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 Nothing on failure

top
FindRecordString
FindRecordString(arrayPath As String, relPath As String, value As String, ByVal caseSensitive As Long, retRelPath As String) As String
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 Nothing on failure

top
FirebaseApplyEvent
FirebaseApplyEvent(name As String, data As String) As Long
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.

top
FirebasePatch
FirebasePatch(jsonPath As String, jsonData As String) As Long
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.

top
FirebasePut
FirebasePut(jsonPath As String, value As String) As Long
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.

top
GetDocRoot
GetDocRoot() As ChilkatJsonObject
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 Nothing on failure

top
HasMember
HasMember(jsonPath As String) As Long
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
IndexOf(name As String) As Long
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.

top
IntAt
IntAt(ByVal index As Long) As Long
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).

top
IntOf
IntOf(jsonPath As String) As Long
Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

top
IsNullAt
IsNullAt(ByVal index As Long) As Long
Introduced in version 9.5.0.56

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

top
IsNullOf
IsNullOf(jsonPath As String) As Long
Introduced in version 9.5.0.56

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

top
Load
Load(json As String) As Long
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.

top
LoadFile
LoadFile(path As String) As Long
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.

top
LoadPredefined
LoadPredefined(name As String) As Long
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.

top
LoadSb
LoadSb(sb As ChilkatStringBuilder) As Long
Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns 1 for success, 0 for failure.

top
NameAt
NameAt(ByVal index As Long) As String
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 Nothing on failure

top
ObjectAt
ObjectAt(ByVal index As Long) As ChilkatJsonObject
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 Nothing on failure

top
ObjectOf
ObjectOf(jsonPath As String) As ChilkatJsonObject
Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns Nothing on failure

top
Predefine
Predefine(name As String) As Long
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.

top
Rename
Rename(oldName As String, newName As String) As Long
Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns 1 for success, 0 for failure.

top
RenameAt
RenameAt(ByVal index As Long, name As String) As Long
Introduced in version 9.5.0.56

Renames the member at index to name.

Returns 1 for success, 0 for failure.

top
SetBoolAt
SetBoolAt(ByVal index As Long, ByVal value As Long) As Long
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.

top
SetBoolOf
SetBoolOf(jsonPath As String, ByVal value As Long) As Long
Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns 1 for success, 0 for failure.

top
SetIntAt
SetIntAt(ByVal index As Long, ByVal value As Long) As Long
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.

top
SetIntOf
SetIntOf(jsonPath As String, ByVal value As Long) As Long
Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns 1 for success, 0 for failure.

top
SetNullAt
SetNullAt(ByVal index As Long) As Long
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.

top
SetNullOf
SetNullOf(jsonPath As String) As Long
Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns 1 for success, 0 for failure.

top
SetNumberAt
SetNumberAt(ByVal index As Long, value As String) As Long
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.

top
SetNumberOf
SetNumberOf(jsonPath As String, value As String) As Long
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.

top
SetStringAt
SetStringAt(ByVal index As Long, value As String) As Long
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.

top
SetStringOf
SetStringOf(jsonPath As String, value As String) As Long
Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns 1 for success, 0 for failure.

top
SizeOfArray
SizeOfArray(jsonPath As String) As Long
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.

top
StringAt
StringAt(ByVal index As Long) As String
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 Nothing on failure

top
StringOf
StringOf(jsonPath As String) As String
Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns Nothing on failure

top
StringOfSb
StringOfSb(jsonPath As String, sb As ChilkatStringBuilder) As Long
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
TypeAt
TypeAt(ByVal index As Long) As Long
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
UpdateBd
UpdateBd(jsonPath As String, encoding As String, bd As ChilkatBinData) As Long
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.

top
UpdateBool
UpdateBool(jsonPath As String, ByVal value As Long) As Long
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
UpdateInt(jsonPath As String, ByVal value As Long) As Long
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.

top
UpdateNewArray
UpdateNewArray(jsonPath As String) As Long
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.

top
UpdateNewObject
UpdateNewObject(jsonPath As String) As Long
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.

top
UpdateNull
UpdateNull(jsonPath As String) As Long
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
UpdateNumber(jsonPath As String, numericStr As String) As Long
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.

top
UpdateSb
UpdateSb(jsonPath As String, sb As ChilkatStringBuilder) As Long
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
UpdateString(jsonPath As String, value As String) As Long
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.

top