JsonObject ActiveX Reference Documentation

JsonObject

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

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

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.

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.

I As Long

Introduced in version 9.5.0.56

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

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

J As Long

Introduced in version 9.5.0.56

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

K As Long

Introduced in version 9.5.0.56

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

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

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.

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.

Concept of LastErrorText

LastErrorText Standard Information

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.

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.

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

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

Size As Long (read-only)

Introduced in version 9.5.0.56

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

(Classic ASP) JSON Iterate Members

(Visual FoxPro) JSON Iterate Members

(PowerBuilder) JSON Iterate Members

(SQL Server) JSON Iterate Members

(Visual Basic 6.0) JSON Iterate Members

(VBScript) JSON Iterate Members

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.

Version As String (read-only)

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

Methods

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.

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

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.

(Classic ASP) Create JSON Document

(Visual FoxPro) Create JSON Document

(PowerBuilder) Create JSON Document

(SQL Server) Create JSON Document

(Visual Basic 6.0) Create JSON Document

(VBScript) Create JSON Document

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

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.

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

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.

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

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.

(Classic ASP) Create JSON Document

(Visual FoxPro) Create JSON Document

(PowerBuilder) Create JSON Document

(SQL Server) Create JSON Document

(Visual Basic 6.0) Create JSON Document

(VBScript) Create JSON Document

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

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.

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.

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

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.

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.

(Classic ASP) JSON Append String Array

(Visual FoxPro) JSON Append String Array

(PowerBuilder) JSON Append String Array

(SQL Server) JSON Append String Array

(Visual Basic 6.0) JSON Append String Array

(VBScript) JSON Append String Array

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

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

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

(Classic ASP) JSON: Access Array Values

(Visual FoxPro) JSON: Access Array Values

(PowerBuilder) JSON: Access Array Values

(SQL Server) JSON: Access Array Values

(Visual Basic 6.0) JSON: Access Array Values

(VBScript) JSON: Access Array Values

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

BoolOf(jsonPath As String) As Long

Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

Clone() As ChilkatJsonObject

Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns Nothing on failure

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.

(Classic ASP) JSON: Renaming and Deleting Members

(Visual FoxPro) JSON: Renaming and Deleting Members

(PowerBuilder) JSON: Renaming and Deleting Members

(SQL Server) JSON: Renaming and Deleting Members

(Visual Basic 6.0) JSON: Renaming and Deleting Members

(VBScript) JSON: Renaming and Deleting Members

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.

(Classic ASP) JSON: Renaming and Deleting Members

(Visual FoxPro) JSON: Renaming and Deleting Members

(PowerBuilder) JSON: Renaming and Deleting Members

(SQL Server) JSON: Renaming and Deleting Members

(Visual Basic 6.0) JSON: Renaming and Deleting Members

(VBScript) JSON: Renaming and Deleting Members

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

(Classic ASP) Pretty Print JSON (Formatter, Beautifier)

(Visual FoxPro) Pretty Print JSON (Formatter, Beautifier)

(PowerBuilder) Pretty Print JSON (Formatter, Beautifier)

(SQL Server) Pretty Print JSON (Formatter, Beautifier)

(Visual Basic 6.0) Pretty Print JSON (Formatter, Beautifier)

(VBScript) Pretty Print JSON (Formatter, Beautifier)

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.

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

(Classic ASP) Using Pre-defined JSON Templates

(Visual FoxPro) Using Pre-defined JSON Templates

(PowerBuilder) Using Pre-defined JSON Templates

(SQL Server) Using Pre-defined JSON Templates

(Visual Basic 6.0) Using Pre-defined JSON Templates

(VBScript) Using Pre-defined JSON Templates

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

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

(Classic ASP) JSON FindRecord Example

(Visual FoxPro) JSON FindRecord Example

(PowerBuilder) JSON FindRecord Example

(SQL Server) JSON FindRecord Example

(Visual Basic 6.0) JSON FindRecord Example

(VBScript) JSON FindRecord Example

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

(Classic ASP) JSON FindRecordString Example

(Visual FoxPro) JSON FindRecordString Example

(PowerBuilder) JSON FindRecordString Example

(SQL Server) JSON FindRecordString Example

(Visual Basic 6.0) JSON FindRecordString Example

(VBScript) JSON FindRecordString Example

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.

(Classic ASP) Firebase Receive Server-Sent Events (text/event-stream)

(Visual FoxPro) Firebase Receive Server-Sent Events (text/event-stream)

(PowerBuilder) Firebase Receive Server-Sent Events (text/event-stream)

(SQL Server) Firebase Receive Server-Sent Events (text/event-stream)

(Visual Basic 6.0) Firebase Receive Server-Sent Events (text/event-stream)

(VBScript) Firebase Receive Server-Sent Events (text/event-stream)

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.

(Classic ASP) Firebase JSON Put and Patch

(Visual FoxPro) Firebase JSON Put and Patch

(PowerBuilder) Firebase JSON Put and Patch

(SQL Server) Firebase JSON Put and Patch

(Visual Basic 6.0) Firebase JSON Put and Patch

(VBScript) Firebase JSON Put and Patch

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.

(Classic ASP) Firebase JSON Put and Patch

(Visual FoxPro) Firebase JSON Put and Patch

(PowerBuilder) Firebase JSON Put and Patch

(SQL Server) Firebase JSON Put and Patch

(Visual Basic 6.0) Firebase JSON Put and Patch

(VBScript) Firebase JSON Put and Patch

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

(Classic ASP) Get the Root of a JSON Document

(Visual FoxPro) Get the Root of a JSON Document

(PowerBuilder) Get the Root of a JSON Document

(SQL Server) Get the Root of a JSON Document

(Visual Basic 6.0) Get the Root of a JSON Document

(VBScript) Get the Root of a JSON Document

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.

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.

(Classic ASP) Get the Index of a JSON Member

(Visual FoxPro) Get the Index of a JSON Member

(PowerBuilder) Get the Index of a JSON Member

(SQL Server) Get the Index of a JSON Member

(Visual Basic 6.0) Get the Index of a JSON Member

(VBScript) Get the Index of a JSON Member

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

(Classic ASP) JSON Iterate Members

(Visual FoxPro) JSON Iterate Members

(PowerBuilder) JSON Iterate Members

(SQL Server) JSON Iterate Members

(Visual Basic 6.0) JSON Iterate Members

(VBScript) JSON Iterate Members

IntOf(jsonPath As String) As Long

Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) Load JSON Data at Path

(Visual FoxPro) Load JSON Data at Path

(PowerBuilder) Load JSON Data at Path

(SQL Server) Load JSON Data at Path

(Visual Basic 6.0) Load JSON Data at Path

(VBScript) Load JSON Data at Path

(Classic ASP) Load a JSON Array

(Visual FoxPro) Load a JSON Array

(PowerBuilder) Load a JSON Array

(SQL Server) Load a JSON Array

(Visual Basic 6.0) Load a JSON Array

(VBScript) Load a JSON Array

(Classic ASP) Loading and Parsing a JSON Array

(Visual FoxPro) Loading and Parsing a JSON Array

(PowerBuilder) Loading and Parsing a JSON Array

(SQL Server) Loading and Parsing a JSON Array

(Visual Basic 6.0) Loading and Parsing a JSON Array

(VBScript) Loading and Parsing a JSON Array

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.

(Classic ASP) Load a JSON Array

(Visual FoxPro) Load a JSON Array

(PowerBuilder) Load a JSON Array

(SQL Server) Load a JSON Array

(Visual Basic 6.0) Load a JSON Array

(VBScript) Load a JSON Array

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.

(Classic ASP) Using Pre-defined JSON Templates

(Visual FoxPro) Using Pre-defined JSON Templates

(PowerBuilder) Using Pre-defined JSON Templates

(SQL Server) Using Pre-defined JSON Templates

(Visual Basic 6.0) Using Pre-defined JSON Templates

(VBScript) Using Pre-defined JSON Templates

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.

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

(Classic ASP) JSON Iterate Members

(Visual FoxPro) JSON Iterate Members

(PowerBuilder) JSON Iterate Members

(SQL Server) JSON Iterate Members

(Visual Basic 6.0) JSON Iterate Members

(VBScript) JSON Iterate Members

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

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

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

(Classic ASP) JSON: Nested Objects

(Visual FoxPro) JSON: Nested Objects

(PowerBuilder) JSON: Nested Objects

(SQL Server) JSON: Nested Objects

(Visual Basic 6.0) JSON: Nested Objects

(VBScript) JSON: Nested Objects

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) Using Pre-defined JSON Templates

(Visual FoxPro) Using Pre-defined JSON Templates

(PowerBuilder) Using Pre-defined JSON Templates

(SQL Server) Using Pre-defined JSON Templates

(Visual Basic 6.0) Using Pre-defined JSON Templates

(VBScript) Using Pre-defined JSON Templates

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.

(Classic ASP) JSON: Renaming and Deleting Members

(Visual FoxPro) JSON: Renaming and Deleting Members

(PowerBuilder) JSON: Renaming and Deleting Members

(SQL Server) JSON: Renaming and Deleting Members

(Visual Basic 6.0) JSON: Renaming and Deleting Members

(VBScript) JSON: Renaming and Deleting Members

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.

(Classic ASP) JSON: Renaming and Deleting Members

(Visual FoxPro) JSON: Renaming and Deleting Members

(PowerBuilder) JSON: Renaming and Deleting Members

(SQL Server) JSON: Renaming and Deleting Members

(Visual Basic 6.0) JSON: Renaming and Deleting Members

(VBScript) JSON: Renaming and Deleting Members

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.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

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.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

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.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

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.

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

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.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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.

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

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

(Classic ASP) JSON Iterate Members

(Visual FoxPro) JSON Iterate Members

(PowerBuilder) JSON Iterate Members

(SQL Server) JSON Iterate Members

(Visual Basic 6.0) JSON Iterate Members

(VBScript) JSON Iterate Members

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

(Classic ASP) JSON: Miscellaneous Operations

(Visual FoxPro) JSON: Miscellaneous Operations

(PowerBuilder) JSON: Miscellaneous Operations

(SQL Server) JSON: Miscellaneous Operations

(Visual Basic 6.0) JSON: Miscellaneous Operations

(VBScript) JSON: Miscellaneous Operations

(Classic ASP) JSON Paths

(Visual FoxPro) JSON Paths

(PowerBuilder) JSON Paths

(SQL Server) JSON Paths

(Visual Basic 6.0) JSON Paths

(VBScript) JSON Paths

(Classic ASP) JSON Paths that need Double Quotes

(Visual FoxPro) JSON Paths that need Double Quotes

(PowerBuilder) JSON Paths that need Double Quotes

(SQL Server) JSON Paths that need Double Quotes

(Visual Basic 6.0) JSON Paths that need Double Quotes

(VBScript) JSON Paths that need Double Quotes

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.

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.

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.

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.

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.

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.

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.

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.

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.

(Classic ASP) JSON UpdateString

(Visual FoxPro) JSON UpdateString

(PowerBuilder) JSON UpdateString

(SQL Server) JSON UpdateString

(Visual Basic 6.0) JSON UpdateString

(VBScript) JSON UpdateString