JsonObject Xojo Plugin Reference Documentation

JsonObject

Current Version: 9.5.0.97

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

Dim jsonObject As New Chilkat.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 Boolean
Introduced in version 9.5.0.56

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

The default value is True.

top
EmitCrLf
EmitCrLf As Boolean
Introduced in version 9.5.0.56

If True then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If False, 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 True.

top
I
I As Int32
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
top
J
J As Int32
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 Int32
Introduced in version 9.5.0.56

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

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 Boolean

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LowerCaseNames
LowerCaseNames As Boolean
Introduced in version 9.5.0.87

If True 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 False.

top
PathPrefix
PathPrefix As String
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
Size As Int32 (read-only)
Introduced in version 9.5.0.56

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

More Information and Examples
top
UncommonOptions
UncommonOptions As String
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
VerboseLogging As Boolean

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.

top
Version
Version As String (read-only)

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

More Information and Examples
top

Methods

AddArrayAt
Function AddArrayAt(index As Int32, name As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddArrayCopyAt
Function AddArrayCopyAt(index As Int32, name As String, jarr As Chilkat.JsonArray) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddBoolAt
Function AddBoolAt(index As Int32, name As String, value As Boolean) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddIntAt
Function AddIntAt(index As Int32, name As String, value As Int32) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddNullAt
Function AddNullAt(index As Int32, name As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddNumberAt
Function AddNumberAt(index As Int32, name As String, numericStr As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddObjectAt
Function AddObjectAt(index As Int32, name As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddObjectCopyAt
Function AddObjectCopyAt(index As Int32, name As String, jsonObj As Chilkat.JsonObject) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AddStringAt
Function AddStringAt(index As Int32, name As String, value As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AppendArray
Function AppendArray(name As String) As Chilkat.JsonArray
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
top
AppendArrayCopy
Function AppendArrayCopy(name As String, jarr As Chilkat.JsonArray) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AppendBool
Function AppendBool(name As String, value As Boolean) As Boolean
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 True for success, False for failure.

top
AppendInt
Function AppendInt(name As String, value As Int32) As Boolean
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 True for success, False for failure.

top
AppendObject
Function AppendObject(name As String) As Chilkat.JsonObject
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
top
AppendObjectCopy
Function AppendObjectCopy(name As String, jsonObj As Chilkat.JsonObject) As Boolean
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 True for success, False for failure.

More Information and Examples
top
AppendString
Function AppendString(name As String, value As String) As Boolean
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 True for success, False for failure.

top
AppendStringArray
Function AppendStringArray(name As String, values As Chilkat.StringTable) As Boolean
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 True for success, False for failure.

More Information and Examples
top
ArrayAt
Function ArrayAt(index As Int32) As Chilkat.JsonArray
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
top
ArrayOf
Function ArrayOf(jsonPath As String) As Chilkat.JsonArray
Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns Nil on failure

top
BoolAt
Function BoolAt(index As Int32) As Boolean
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
top
BoolOf
Function BoolOf(jsonPath As String) As Boolean
Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

More Information and Examples
top
BytesOf
Function BytesOf(jsonPath As String, encoding As String, bd As Chilkat.BinData) As Boolean
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 True for success, False for failure.

top
Clear
Sub 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() As Chilkat.JsonObject
Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns Nil on failure

top
DateOf
Function DateOf(jsonPath As String, dateTime As Chilkat.CkDateTime) As Boolean
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 True for success, False for failure.

top
Delete
Function Delete(name As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
DeleteAt
Function DeleteAt(index As Int32) As Boolean
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 True for success, False for failure.

More Information and Examples
top
DeleteRecords
Function DeleteRecords(arrayPath As String, relpath As String, value As String, caseSensitive As Boolean) As Int32
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 As String, bLocal As Boolean, dt As Chilkat.DtObj) As Boolean
Introduced in version 9.5.0.73

Fills the dt with the date/time string located at jsonPath. If bLocal is True, 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 True for success, False for failure.

More Information and Examples
top
Emit
Function Emit() As String
Introduced in version 9.5.0.56

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

Returns Nil on failure

More Information and Examples
top
EmitBd
Function EmitBd(bd As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.77

Emits (appends) to the contents of bd.

Returns True for success, False for failure.

top
EmitSb
Function EmitSb(sb As Chilkat.StringBuilder) As Boolean
Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns True for success, False for failure.

top
EmitWithSubs
Function EmitWithSubs(subs As Chilkat.Hashtable, omitEmpty As Boolean) As String
Introduced in version 9.5.0.67

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

Returns Nil on failure

More Information and Examples
top
FindObjectWithMember
Function FindObjectWithMember(name As String) As Chilkat.JsonObject
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 As String, relPath As String, value As String, caseSensitive As Boolean) As Chilkat.JsonObject
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
top
FindRecordString
Function FindRecordString(arrayPath As String, relPath As String, value As String, caseSensitive As Boolean, 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 Nil on failure

More Information and Examples
top
FirebaseApplyEvent
Function FirebaseApplyEvent(name As String, data As String) As Boolean
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 True for success, False for failure.

top
FirebasePatch
Function FirebasePatch(jsonPath As String, jsonData As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
FirebasePut
Function FirebasePut(jsonPath As String, value As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
GetDocRoot
Function GetDocRoot() As Chilkat.JsonObject
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
top
HasMember
Function HasMember(jsonPath As String) As Boolean
Introduced in version 9.5.0.58

Returns True if the item at the jsonPath exists.

Returns True for success, False for failure.

top
IndexOf
Function IndexOf(name As String) As Int32
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
top
IntAt
Function IntAt(index As Int32) As Int32
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
top
IntOf
Function IntOf(jsonPath As String) As Int32
Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

top
IsNullAt
Function IsNullAt(index As Int32) As Boolean
Introduced in version 9.5.0.56

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

More Information and Examples
top
IsNullOf
Function IsNullOf(jsonPath As String) As Boolean
Introduced in version 9.5.0.56

Returns True if the value at the specified jsonPath is null. Otherwise returns False.

More Information and Examples
top
JsonTypeOf
Function JsonTypeOf(jsonPath As String) As Int32
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 As String) As Boolean
Introduced in version 9.5.0.56

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

Returns True for success, False for failure.

top
LoadBd
Function LoadBd(bd As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.77

Loads the contents of bd.

Returns True for success, False for failure.

top
LoadFile
Function LoadFile(path As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
LoadPredefined
Function LoadPredefined(name As String) As Boolean
Introduced in version 9.5.0.67

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

Returns True for success, False for failure.

More Information and Examples
top
LoadSb
Function LoadSb(sb As Chilkat.StringBuilder) As Boolean
Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns True for success, False for failure.

top
MoveMember
Function MoveMember(fromIndex As Int32, toIndex As Int32) As Boolean
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 True for success, False for failure.

top
NameAt
Function NameAt(index As Int32) 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 Nil on failure

More Information and Examples
top
ObjectAt
Function ObjectAt(index As Int32) As Chilkat.JsonObject
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
top
ObjectOf
Function ObjectOf(jsonPath As String) As Chilkat.JsonObject
Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns Nil on failure

More Information and Examples
top
Predefine
Function Predefine(name As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
Rename
Function Rename(oldName As String, newName As String) As Boolean
Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns True for success, False for failure.

More Information and Examples
top
RenameAt
Function RenameAt(index As Int32, name As String) As Boolean
Introduced in version 9.5.0.56

Renames the member at index to name.

Returns True for success, False for failure.

More Information and Examples
top
SetBoolAt
Function SetBoolAt(index As Int32, value As Boolean) As Boolean
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 True for success, False for failure.

More Information and Examples
top
SetBoolOf
Function SetBoolOf(jsonPath As String, value As Boolean) As Boolean
Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns True for success, False for failure.

More Information and Examples
top
SetIntAt
Function SetIntAt(index As Int32, value As Int32) As Boolean
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 True for success, False for failure.

More Information and Examples
top
SetIntOf
Function SetIntOf(jsonPath As String, value As Int32) As Boolean
Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns True for success, False for failure.

More Information and Examples
top
SetNullAt
Function SetNullAt(index As Int32) As Boolean
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 True for success, False for failure.

More Information and Examples
top
SetNullOf
Function SetNullOf(jsonPath As String) As Boolean
Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns True for success, False for failure.

More Information and Examples
top
SetNumberAt
Function SetNumberAt(index As Int32, value As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
SetNumberOf
Function SetNumberOf(jsonPath As String, value As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
SetStringAt
Function SetStringAt(index As Int32, value As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
SetStringOf
Function SetStringOf(jsonPath As String, value As String) As Boolean
Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns True for success, False for failure.

More Information and Examples
top
SizeOfArray
Function SizeOfArray(jsonPath As String) As Int32
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
top
StringAt
Function StringAt(index As Int32) 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 Nil on failure

More Information and Examples
top
StringOf
Function StringOf(jsonPath As String) As String
Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns Nil on failure

top
StringOfEquals
Function StringOfEquals(jsonPath As String, value As String, caseSensitive As Boolean) As Boolean
Introduced in version 9.5.0.96

Returns True if the string value at the specified jsonPath equals value. Otherwise returns False

top
StringOfSb
Function StringOfSb(jsonPath As String, sb As Chilkat.StringBuilder) As Boolean
Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns True for success, False for failure.

top
Swap
Function Swap(index1 As Int32, index2 As Int32) As Boolean
Introduced in version 9.5.0.76

Swaps the positions of members at index1 and index2.

Returns True for success, False for failure.

More Information and Examples
top
TypeAt
Function TypeAt(index As Int32) As Int32
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 As String) As UInt32
Introduced in version 9.5.0.96

Returns the unsigned integer at the specified jsonPath.

top
UpdateBd
Function UpdateBd(jsonPath As String, encoding As String, bd As Chilkat.BinData) As Boolean
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 True for success, False for failure.

top
UpdateBool
Function UpdateBool(jsonPath As String, value As Boolean) As Boolean
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 True for success, False for failure.

top
UpdateInt
Function UpdateInt(jsonPath As String, value As Int32) As Boolean
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 True for success, False for failure.

More Information and Examples
top
UpdateNewArray
Function UpdateNewArray(jsonPath As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
UpdateNewObject
Function UpdateNewObject(jsonPath As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
UpdateNull
Function UpdateNull(jsonPath As String) As Boolean
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 True for success, False for failure.

top
UpdateNumber
Function UpdateNumber(jsonPath As String, numericStr As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
UpdateSb
Function UpdateSb(jsonPath As String, sb As Chilkat.StringBuilder) As Boolean
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 True for success, False for failure.

top
UpdateString
Function UpdateString(jsonPath As String, value As String) As Boolean
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 True for success, False for failure.

More Information and Examples
top
UpdateUInt
Function UpdateUInt(jsonPath As String, value As UInt32) As Boolean
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 True for success, False for failure.

top
WriteFile
Function WriteFile(path As String) As Boolean
Introduced in version 9.5.0.76

Saves the JSON to a file.

Returns True for success, False for failure.

top