JsonObject ActiveX Reference Documentation

JsonObject

Current Version: 10.1.0

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

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.JsonObject" instead of "Chilkat.JsonObject"
For a specific major version, use "Chilkat.JsonObject.<major_version>", such as "Chilkat.JsonObject.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

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

(AutoIt)
$obj = ObjCreate("Chilkat.JsonObject")

(Visual Basic 6.0)
Dim obj As New ChilkatJsonObject

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

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

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

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

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

(Javascript)
var obj = new ActiveXObject("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.

More Information and Examples
(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.
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.

More Information and Examples
(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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)

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.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard 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

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)

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

More Information and Examples
Long Strings Returned by ActiveX Methods in SQL Server
top
LastStringResultLen
LastStringResultLen As Long (read-only)

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

top
LowerCaseNames
LowerCaseNames As Long
Introduced in version 9.5.0.87

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

The default value is 0.

top
PathPrefix
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 Long (read-only)
Introduced in version 9.5.0.56

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

More Information and Examples
(AutoIt) JSON Iterate Members(Classic ASP) JSON Iterate Members(PowerBuilder) JSON Iterate Members(SQL Server) JSON Iterate Members(VBScript) JSON Iterate Members(Visual Basic 6.0) JSON Iterate Members(Visual FoxPro) JSON Iterate Members
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 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.94"

More Information and Examples
(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.
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.

More Information and Examples
(AutoIt) Create more Complex JSON Document(Classic ASP) Create more Complex JSON Document(PowerBuilder) Create more Complex JSON Document(SQL Server) Create more Complex JSON Document(VBScript) Create more Complex JSON Document(Visual Basic 6.0) Create more Complex JSON Document(Visual FoxPro) Create more Complex JSON Document
top
AddArrayCopyAt
AddArrayCopyAt(ByVal index As Long, name As String, jarr As ChilkatJsonArray) As Long
Introduced in version 9.5.0.82

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

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) JSON AddArrayCopyAt Example(Classic ASP) JSON AddArrayCopyAt Example(PowerBuilder) JSON AddArrayCopyAt Example(SQL Server) JSON AddArrayCopyAt Example(VBScript) JSON AddArrayCopyAt Example(Visual Basic 6.0) JSON AddArrayCopyAt Example(Visual FoxPro) JSON AddArrayCopyAt Example
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations
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.

More Information and Examples
(AutoIt) Create JSON Document(Classic ASP) Create JSON Document(PowerBuilder) Create JSON Document(SQL Server) Create JSON Document(VBScript) Create JSON Document(Visual Basic 6.0) Create JSON Document(Visual FoxPro) Create JSON Document
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations
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.

More Information and Examples
(AutoIt) Create more Complex JSON Document(Classic ASP) Create more Complex JSON Document(PowerBuilder) Create more Complex JSON Document(SQL Server) Create more Complex JSON Document(VBScript) Create more Complex JSON Document(Visual Basic 6.0) Create more Complex JSON Document(Visual FoxPro) Create more Complex JSON Document
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.

More Information and Examples
(AutoIt) Create more Complex JSON Document(Classic ASP) Create more Complex JSON Document(PowerBuilder) Create more Complex JSON Document(SQL Server) Create more Complex JSON Document(VBScript) Create more Complex JSON Document(Visual Basic 6.0) Create more Complex JSON Document(Visual FoxPro) Create more Complex JSON Document
top
AddObjectCopyAt
AddObjectCopyAt(ByVal index As Long, name As String, jsonObj As ChilkatJsonObject) As Long
Introduced in version 9.5.0.82

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

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) JSON AddObjectCopyAt Example(Classic ASP) JSON AddObjectCopyAt Example(PowerBuilder) JSON AddObjectCopyAt Example(SQL Server) JSON AddObjectCopyAt Example(VBScript) JSON AddObjectCopyAt Example(Visual Basic 6.0) JSON AddObjectCopyAt Example(Visual FoxPro) JSON AddObjectCopyAt Example
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.

More Information and Examples
(AutoIt) Create JSON Document(Classic ASP) Create JSON Document(PowerBuilder) Create JSON Document(SQL Server) Create JSON Document(VBScript) Create JSON Document(Visual Basic 6.0) Create JSON Document(Visual FoxPro) Create JSON Document
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.

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

Returns Nothing on failure

More Information and Examples
(AutoIt) JSON AppendArray Example(Classic ASP) JSON AppendArray Example(PowerBuilder) JSON AppendArray Example(SQL Server) JSON AppendArray Example(VBScript) JSON AppendArray Example(Visual Basic 6.0) JSON AppendArray Example(Visual FoxPro) JSON AppendArray Example
top
AppendArrayCopy
AppendArrayCopy(name As String, jarr As ChilkatJsonArray) As Long
Introduced in version 9.5.0.82

Appends a copy of a JSON array.

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

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) JSON AppendArrayCopy Example(Classic ASP) JSON AppendArrayCopy Example(PowerBuilder) JSON AppendArrayCopy Example(SQL Server) JSON AppendArrayCopy Example(VBScript) JSON AppendArrayCopy Example(Visual Basic 6.0) JSON AppendArrayCopy Example(Visual FoxPro) JSON AppendArrayCopy Example
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.)

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

Returns 1 for success, 0 for failure.

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

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

Returns 1 for success, 0 for failure.

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

More Information and Examples
(AutoIt) JSON AppendObject Example(Classic ASP) JSON AppendObject Example(PowerBuilder) JSON AppendObject Example(SQL Server) JSON AppendObject Example(VBScript) JSON AppendObject Example(Visual Basic 6.0) JSON AppendObject Example(Visual FoxPro) JSON AppendObject Example
top
AppendObjectCopy
AppendObjectCopy(name As String, jsonObj As ChilkatJsonObject) As Long
Introduced in version 9.5.0.82

Appends a copy of a JSON object.

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

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) JSON AppendObjectCopy Example(Classic ASP) JSON AppendObjectCopy Example(PowerBuilder) JSON AppendObjectCopy Example(SQL Server) JSON AppendObjectCopy Example(VBScript) JSON AppendObjectCopy Example(Visual Basic 6.0) JSON AppendObjectCopy Example(Visual FoxPro) JSON AppendObjectCopy Example
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.)

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

Returns 1 for success, 0 for failure.

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

Appends an array of string values.

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

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) JSON Append String Array(Classic ASP) JSON Append String Array(PowerBuilder) JSON Append String Array(SQL Server) JSON Append String Array(VBScript) JSON Append String Array(Visual Basic 6.0) JSON Append String Array(Visual FoxPro) JSON Append String Array
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

More Information and Examples
(AutoIt) Create more Complex JSON Document(Classic ASP) Create more Complex JSON Document(PowerBuilder) Create more Complex JSON Document(SQL Server) Create more Complex JSON Document(VBScript) Create more Complex JSON Document(Visual Basic 6.0) Create more Complex JSON Document(Visual FoxPro) Create more Complex JSON Document
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

More Information and Examples
(AutoIt) JSON: Access Array Values(Classic ASP) JSON: Access Array Values(PowerBuilder) JSON: Access Array Values(SQL Server) JSON: Access Array Values(VBScript) JSON: Access Array Values(Visual Basic 6.0) JSON: Access Array Values(Visual FoxPro) JSON: Access Array Values(AutoIt) Modify Parts of JSON Document(Classic ASP) Modify Parts of JSON Document(PowerBuilder) Modify Parts of JSON Document(SQL Server) Modify Parts of JSON Document(VBScript) Modify Parts of JSON Document(Visual Basic 6.0) Modify Parts of JSON Document(Visual FoxPro) Modify Parts of JSON Document(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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).

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations
top
BoolOf
BoolOf(jsonPath As String) As Long
Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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.

More Information and Examples
(AutoIt) Read/Write JSON with Binary Data such as JPEG Files(Classic ASP) Read/Write JSON with Binary Data such as JPEG Files(PowerBuilder) Read/Write JSON with Binary Data such as JPEG Files(SQL Server) Read/Write JSON with Binary Data such as JPEG Files(VBScript) Read/Write JSON with Binary Data such as JPEG Files(Visual Basic 6.0) Read/Write JSON with Binary Data such as JPEG Files(Visual FoxPro) Read/Write JSON with Binary Data such as JPEG Files
top
Clear
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
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.

More Information and Examples
(AutoIt) JSON Date Parsing(Classic ASP) JSON Date Parsing(PowerBuilder) JSON Date Parsing(SQL Server) JSON Date Parsing(VBScript) JSON Date Parsing(Visual Basic 6.0) JSON Date Parsing(Visual FoxPro) JSON Date Parsing(AutoIt) Parse a Microsoft JSON Date (MS AJAX Date)(Classic ASP) Parse a Microsoft JSON Date (MS AJAX Date)(PowerBuilder) Parse a Microsoft JSON Date (MS AJAX Date)(SQL Server) Parse a Microsoft JSON Date (MS AJAX Date)(VBScript) Parse a Microsoft JSON Date (MS AJAX Date)(Visual Basic 6.0) Parse a Microsoft JSON Date (MS AJAX Date)(Visual FoxPro) Parse a Microsoft JSON Date (MS AJAX Date)
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. Note: The name is not a tag path. It is the name of a member of this JSON object.

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) JSON: Renaming and Deleting Members(Classic ASP) JSON: Renaming and Deleting Members(PowerBuilder) JSON: Renaming and Deleting Members(SQL Server) JSON: Renaming and Deleting Members(VBScript) JSON: Renaming and Deleting Members(Visual Basic 6.0) JSON: Renaming and Deleting Members(Visual FoxPro) JSON: Renaming and Deleting Members
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.

More Information and Examples
(AutoIt) JSON: Renaming and Deleting Members(Classic ASP) JSON: Renaming and Deleting Members(PowerBuilder) JSON: Renaming and Deleting Members(SQL Server) JSON: Renaming and Deleting Members(VBScript) JSON: Renaming and Deleting Members(Visual Basic 6.0) JSON: Renaming and Deleting Members(Visual FoxPro) JSON: Renaming and Deleting Members
top
DeleteRecords
DeleteRecords(arrayPath As String, relpath As String, value As String, ByVal caseSensitive As Long) As Long
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
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.

More Information and Examples
(AutoIt) JSON Date Parsing(Classic ASP) JSON Date Parsing(PowerBuilder) JSON Date Parsing(SQL Server) JSON Date Parsing(VBScript) JSON Date Parsing(Visual Basic 6.0) JSON Date Parsing(Visual FoxPro) JSON Date Parsing
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

More Information and Examples
(AutoIt) Pretty Print JSON (Formatter, Beautifier)(Classic ASP) Pretty Print JSON (Formatter, Beautifier)(PowerBuilder) Pretty Print JSON (Formatter, Beautifier)(SQL Server) Pretty Print JSON (Formatter, Beautifier)(VBScript) Pretty Print JSON (Formatter, Beautifier)(Visual Basic 6.0) Pretty Print JSON (Formatter, Beautifier)(Visual FoxPro) Pretty Print JSON (Formatter, Beautifier)
top
EmitBd
EmitBd(bd As ChilkatBinData) As Long
Introduced in version 9.5.0.77

Emits (appends) to the contents of bd.

Returns 1 for success, 0 for 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

More Information and Examples
(AutoIt) Using Pre-defined JSON Templates(Classic ASP) Using Pre-defined JSON Templates(PowerBuilder) Using Pre-defined JSON Templates(SQL Server) Using Pre-defined JSON Templates(VBScript) Using Pre-defined JSON Templates(Visual Basic 6.0) Using Pre-defined JSON Templates(Visual FoxPro) Using Pre-defined JSON Templates
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

More Information and Examples
(AutoIt) JSON FindRecord Example(Classic ASP) JSON FindRecord Example(PowerBuilder) JSON FindRecord Example(SQL Server) JSON FindRecord Example(VBScript) JSON FindRecord Example(Visual Basic 6.0) JSON FindRecord Example(Visual FoxPro) JSON FindRecord Example
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

More Information and Examples
(AutoIt) JSON FindRecordString Example(Classic ASP) JSON FindRecordString Example(PowerBuilder) JSON FindRecordString Example(SQL Server) JSON FindRecordString Example(VBScript) JSON FindRecordString Example(Visual Basic 6.0) JSON FindRecordString Example(Visual FoxPro) JSON FindRecordString Example
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.

More Information and Examples
(AutoIt) Firebase Receive Server-Sent Events (text/event-stream)(Classic ASP) 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)(VBScript) Firebase Receive Server-Sent Events (text/event-stream)(Visual Basic 6.0) Firebase Receive Server-Sent Events (text/event-stream)(Visual FoxPro) Firebase Receive Server-Sent Events (text/event-stream)
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.

More Information and Examples
(AutoIt) Firebase JSON Put and Patch(Classic ASP) Firebase JSON Put and Patch(PowerBuilder) Firebase JSON Put and Patch(SQL Server) Firebase JSON Put and Patch(VBScript) Firebase JSON Put and Patch(Visual Basic 6.0) Firebase JSON Put and Patch(Visual FoxPro) Firebase JSON Put and Patch
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.

More Information and Examples
(AutoIt) Firebase JSON Put and Patch(Classic ASP) Firebase JSON Put and Patch(PowerBuilder) Firebase JSON Put and Patch(SQL Server) Firebase JSON Put and Patch(VBScript) Firebase JSON Put and Patch(Visual Basic 6.0) Firebase JSON Put and Patch(Visual FoxPro) Firebase JSON Put and Patch
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

More Information and Examples
(AutoIt) Get the Root of a JSON Document(Classic ASP) Get the Root of a JSON Document(PowerBuilder) Get the Root of a JSON Document(SQL Server) Get the Root of a JSON Document(VBScript) Get the Root of a JSON Document(Visual Basic 6.0) Get the Root of a JSON Document(Visual FoxPro) Get the Root of a JSON Document
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.

More Information and Examples
(AutoIt) Get the Index of a JSON Member(Classic ASP) Get the Index of a JSON Member(PowerBuilder) Get the Index of a JSON Member(SQL Server) Get the Index of a JSON Member(VBScript) Get the Index of a JSON Member(Visual Basic 6.0) Get the Index of a JSON Member(Visual FoxPro) Get the Index of a JSON Member
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).

More Information and Examples
(AutoIt) JSON Iterate Members(Classic ASP) JSON Iterate Members(PowerBuilder) JSON Iterate Members(SQL Server) JSON Iterate Members(VBScript) JSON Iterate Members(Visual Basic 6.0) JSON Iterate Members(Visual FoxPro) JSON Iterate Members
top
IntOf
IntOf(jsonPath As String) As Long
Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths(AutoIt) Check if Integer Exists at JSON Path(Classic ASP) Check if Integer Exists at JSON Path(PowerBuilder) Check if Integer Exists at JSON Path(SQL Server) Check if Integer Exists at JSON Path(VBScript) Check if Integer Exists at JSON Path(Visual Basic 6.0) Check if Integer Exists at JSON Path(Visual FoxPro) Check if Integer Exists at JSON Path(AutoIt) Demonstrates how to Handle Large Integers in JSON(Classic ASP) Demonstrates how to Handle Large Integers in JSON(PowerBuilder) Demonstrates how to Handle Large Integers in JSON(SQL Server) Demonstrates how to Handle Large Integers in JSON(VBScript) Demonstrates how to Handle Large Integers in JSON(Visual Basic 6.0) Demonstrates how to Handle Large Integers in JSON(Visual FoxPro) Demonstrates how to Handle Large Integers in JSON
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
top
JsonTypeOf
JsonTypeOf(jsonPath As String) As Long
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
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.

More Information and Examples
(AutoIt) Load JSON Data at Path(Classic ASP) Load JSON Data at Path(PowerBuilder) Load JSON Data at Path(SQL Server) Load JSON Data at Path(VBScript) Load JSON Data at Path(Visual Basic 6.0) Load JSON Data at Path(Visual FoxPro) Load JSON Data at Path(AutoIt) Load a JSON Array(Classic ASP) Load a JSON Array(PowerBuilder) Load a JSON Array(SQL Server) Load a JSON Array(VBScript) Load a JSON Array(Visual Basic 6.0) Load a JSON Array(Visual FoxPro) Load a JSON Array(AutoIt) Loading and Parsing a JSON Array(Classic ASP) Loading and Parsing a JSON Array(PowerBuilder) Loading and Parsing a JSON Array(SQL Server) Loading and Parsing a JSON Array(VBScript) Loading and Parsing a JSON Array(Visual Basic 6.0) Loading and Parsing a JSON Array(Visual FoxPro) Loading and Parsing a JSON Array(AutoIt) Understanding JSON Array vs JSON Object(Classic ASP) Understanding JSON Array vs JSON Object(PowerBuilder) Understanding JSON Array vs JSON Object(SQL Server) Understanding JSON Array vs JSON Object(VBScript) Understanding JSON Array vs JSON Object(Visual Basic 6.0) Understanding JSON Array vs JSON Object(Visual FoxPro) Understanding JSON Array vs JSON Object
top
LoadBd
LoadBd(bd As ChilkatBinData) As Long
Introduced in version 9.5.0.77

Loads the contents of bd.

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.

More Information and Examples
(AutoIt) Load a JSON Array(Classic ASP) Load a JSON Array(PowerBuilder) Load a JSON Array(SQL Server) Load a JSON Array(VBScript) Load a JSON Array(Visual Basic 6.0) Load a JSON Array(Visual FoxPro) Load a JSON Array
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.

More Information and Examples
(AutoIt) Using Pre-defined JSON Templates(Classic ASP) Using Pre-defined JSON Templates(PowerBuilder) Using Pre-defined JSON Templates(SQL Server) Using Pre-defined JSON Templates(VBScript) Using Pre-defined JSON Templates(Visual Basic 6.0) Using Pre-defined JSON Templates(Visual FoxPro) Using Pre-defined JSON Templates
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.

More Information and Examples
(AutoIt) Download a Specific GMail Message into a Chilkat Email Object(Classic ASP) Download a Specific GMail Message into a Chilkat Email Object(PowerBuilder) Download a Specific GMail Message into a Chilkat Email Object(SQL Server) Download a Specific GMail Message into a Chilkat Email Object(VBScript) Download a Specific GMail Message into a Chilkat Email Object(Visual Basic 6.0) Download a Specific GMail Message into a Chilkat Email Object(Visual FoxPro) Download a Specific GMail Message into a Chilkat Email Object
top
MoveMember
MoveMember(ByVal fromIndex As Long, ByVal toIndex As Long) As Long
Introduced in version 9.5.0.80

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

Returns 1 for success, 0 for failure.

top
NameAt
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

More Information and Examples
(AutoIt) JSON Iterate Members(Classic ASP) JSON Iterate Members(PowerBuilder) JSON Iterate Members(SQL Server) JSON Iterate Members(VBScript) JSON Iterate Members(Visual Basic 6.0) JSON Iterate Members(Visual FoxPro) JSON Iterate Members
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

More Information and Examples
(AutoIt) Create more Complex JSON Document(Classic ASP) Create more Complex JSON Document(PowerBuilder) Create more Complex JSON Document(SQL Server) Create more Complex JSON Document(VBScript) Create more Complex JSON Document(Visual Basic 6.0) Create more Complex JSON Document(Visual FoxPro) Create more Complex JSON Document
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

More Information and Examples
(AutoIt) JSON: Nested Objects(Classic ASP) JSON: Nested Objects(PowerBuilder) JSON: Nested Objects(SQL Server) JSON: Nested Objects(VBScript) JSON: Nested Objects(Visual Basic 6.0) JSON: Nested Objects(Visual FoxPro) JSON: Nested Objects(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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.

More Information and Examples
(AutoIt) Using Pre-defined JSON Templates(Classic ASP) Using Pre-defined JSON Templates(PowerBuilder) Using Pre-defined JSON Templates(SQL Server) Using Pre-defined JSON Templates(VBScript) Using Pre-defined JSON Templates(Visual Basic 6.0) Using Pre-defined JSON Templates(Visual FoxPro) Using Pre-defined JSON Templates
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.

More Information and Examples
(AutoIt) JSON: Renaming and Deleting Members(Classic ASP) JSON: Renaming and Deleting Members(PowerBuilder) JSON: Renaming and Deleting Members(SQL Server) JSON: Renaming and Deleting Members(VBScript) JSON: Renaming and Deleting Members(Visual Basic 6.0) JSON: Renaming and Deleting Members(Visual FoxPro) JSON: Renaming and Deleting Members
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.

More Information and Examples
(AutoIt) JSON: Renaming and Deleting Members(Classic ASP) JSON: Renaming and Deleting Members(PowerBuilder) JSON: Renaming and Deleting Members(SQL Server) JSON: Renaming and Deleting Members(VBScript) JSON: Renaming and Deleting Members(Visual Basic 6.0) JSON: Renaming and Deleting Members(Visual FoxPro) JSON: Renaming and Deleting Members
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.

More Information and Examples
(AutoIt) Modify Parts of JSON Document(Classic ASP) Modify Parts of JSON Document(PowerBuilder) Modify Parts of JSON Document(SQL Server) Modify Parts of JSON Document(VBScript) Modify Parts of JSON Document(Visual Basic 6.0) Modify Parts of JSON Document(Visual FoxPro) Modify Parts of JSON Document
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.

More Information and Examples
(AutoIt) Modify Parts of JSON Document(Classic ASP) Modify Parts of JSON Document(PowerBuilder) Modify Parts of JSON Document(SQL Server) Modify Parts of JSON Document(VBScript) Modify Parts of JSON Document(Visual Basic 6.0) Modify Parts of JSON Document(Visual FoxPro) Modify Parts of JSON Document(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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.

More Information and Examples
(AutoIt) Modify Parts of JSON Document(Classic ASP) Modify Parts of JSON Document(PowerBuilder) Modify Parts of JSON Document(SQL Server) Modify Parts of JSON Document(VBScript) Modify Parts of JSON Document(Visual Basic 6.0) Modify Parts of JSON Document(Visual FoxPro) Modify Parts of JSON Document
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.

More Information and Examples
(AutoIt) Modify Parts of JSON Document(Classic ASP) Modify Parts of JSON Document(PowerBuilder) Modify Parts of JSON Document(SQL Server) Modify Parts of JSON Document(VBScript) Modify Parts of JSON Document(Visual Basic 6.0) Modify Parts of JSON Document(Visual FoxPro) Modify Parts of JSON Document(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations
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.

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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.

More Information and Examples
(AutoIt) Modify Parts of JSON Document(Classic ASP) Modify Parts of JSON Document(PowerBuilder) Modify Parts of JSON Document(SQL Server) Modify Parts of JSON Document(VBScript) Modify Parts of JSON Document(Visual Basic 6.0) Modify Parts of JSON Document(Visual FoxPro) Modify Parts of JSON Document
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.

More Information and Examples
(AutoIt) Modify Parts of JSON Document(Classic ASP) Modify Parts of JSON Document(PowerBuilder) Modify Parts of JSON Document(SQL Server) Modify Parts of JSON Document(VBScript) Modify Parts of JSON Document(Visual Basic 6.0) Modify Parts of JSON Document(Visual FoxPro) Modify Parts of JSON Document(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
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.

More Information and Examples
(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths
top
Sort
Sort(ByVal ascending As Long, ByVal caseSensitive As Long)
Introduced in version 9.5.0.100

Sorts the JSON members by the member name.

More Information and Examples
(AutoIt) Sort JSON Object by Member Key Name(Classic ASP) Sort JSON Object by Member Key Name(PowerBuilder) Sort JSON Object by Member Key Name(SQL Server) Sort JSON Object by Member Key Name(VBScript) Sort JSON Object by Member Key Name(Visual Basic 6.0) Sort JSON Object by Member Key Name(Visual FoxPro) Sort JSON Object by Member Key Name
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

More Information and Examples
(AutoIt) JSON Iterate Members(Classic ASP) JSON Iterate Members(PowerBuilder) JSON Iterate Members(SQL Server) JSON Iterate Members(VBScript) JSON Iterate Members(Visual Basic 6.0) JSON Iterate Members(Visual FoxPro) JSON Iterate Members
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

More Information and Examples
(AutoIt) JSON: Miscellaneous Operations(Classic ASP) JSON: Miscellaneous Operations(PowerBuilder) JSON: Miscellaneous Operations(SQL Server) JSON: Miscellaneous Operations(VBScript) JSON: Miscellaneous Operations(Visual Basic 6.0) JSON: Miscellaneous Operations(Visual FoxPro) JSON: Miscellaneous Operations(AutoIt) JSON Paths(Classic ASP) JSON Paths(PowerBuilder) JSON Paths(SQL Server) JSON Paths(VBScript) JSON Paths(Visual Basic 6.0) JSON Paths(Visual FoxPro) JSON Paths(AutoIt) JSON Paths that need Double Quotes(Classic ASP) JSON Paths that need Double Quotes(PowerBuilder) JSON Paths that need Double Quotes(SQL Server) JSON Paths that need Double Quotes(VBScript) JSON Paths that need Double Quotes(Visual Basic 6.0) JSON Paths that need Double Quotes(Visual FoxPro) JSON Paths that need Double Quotes
top
StringOfEquals
StringOfEquals(jsonPath As String, value As String, ByVal caseSensitive As Long) As Long
Introduced in version 9.5.0.96

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

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
Swap
Swap(ByVal index1 As Long, ByVal index2 As Long) As Long
Introduced in version 9.5.0.76

Swaps the positions of members at index1 and index2.

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) Swap JSON Objects(Classic ASP) Swap JSON Objects(PowerBuilder) Swap JSON Objects(SQL Server) Swap JSON Objects(VBScript) Swap JSON Objects(Visual Basic 6.0) Swap JSON Objects(Visual FoxPro) Swap JSON Objects
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
UIntOf
UIntOf(jsonPath As String) As Long
Introduced in version 9.5.0.96

Returns the unsigned integer at the specified jsonPath.

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.

More Information and Examples
(AutoIt) Read/Write JSON with Binary Data such as JPEG Files(Classic ASP) Read/Write JSON with Binary Data such as JPEG Files(PowerBuilder) Read/Write JSON with Binary Data such as JPEG Files(SQL Server) Read/Write JSON with Binary Data such as JPEG Files(VBScript) Read/Write JSON with Binary Data such as JPEG Files(Visual Basic 6.0) Read/Write JSON with Binary Data such as JPEG Files(Visual FoxPro) Read/Write JSON with Binary Data such as JPEG Files
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.

More Information and Examples
(AutoIt) JSON UpdateNumber vs UpdateInt(Classic ASP) JSON UpdateNumber vs UpdateInt(PowerBuilder) JSON UpdateNumber vs UpdateInt(SQL Server) JSON UpdateNumber vs UpdateInt(VBScript) JSON UpdateNumber vs UpdateInt(Visual Basic 6.0) JSON UpdateNumber vs UpdateInt(Visual FoxPro) JSON UpdateNumber vs UpdateInt
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.

More Information and Examples
(AutoIt) JSON Insert Empty Array or Object(Classic ASP) JSON Insert Empty Array or Object(PowerBuilder) JSON Insert Empty Array or Object(SQL Server) JSON Insert Empty Array or Object(VBScript) JSON Insert Empty Array or Object(Visual Basic 6.0) JSON Insert Empty Array or Object(Visual FoxPro) JSON Insert Empty Array or Object
top
UpdateNewObject
UpdateNewObject(jsonPath As String) As Long
Introduced in version 9.5.0.75

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

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) JSON Insert Empty Array or Object(Classic ASP) JSON Insert Empty Array or Object(PowerBuilder) JSON Insert Empty Array or Object(SQL Server) JSON Insert Empty Array or Object(VBScript) JSON Insert Empty Array or Object(Visual Basic 6.0) JSON Insert Empty Array or Object(Visual FoxPro) JSON Insert Empty Array or Object
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.

More Information and Examples
(AutoIt) JSON UpdateNumber vs UpdateInt(Classic ASP) JSON UpdateNumber vs UpdateInt(PowerBuilder) JSON UpdateNumber vs UpdateInt(SQL Server) JSON UpdateNumber vs UpdateInt(VBScript) JSON UpdateNumber vs UpdateInt(Visual Basic 6.0) JSON UpdateNumber vs UpdateInt(Visual FoxPro) JSON UpdateNumber vs UpdateInt
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.

More Information and Examples
(AutoIt) JSON UpdateString(Classic ASP) JSON UpdateString(PowerBuilder) JSON UpdateString(SQL Server) JSON UpdateString(VBScript) JSON UpdateString(Visual Basic 6.0) JSON UpdateString(Visual FoxPro) JSON UpdateString
top
UpdateUInt
UpdateUInt(jsonPath As String, ByVal value As Long) As Long
Introduced in version 9.5.0.96

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

Returns 1 for success, 0 for failure.

top
WriteFile
WriteFile(path As String) As Long
Introduced in version 9.5.0.76

Saves the JSON to a file.

Returns 1 for success, 0 for failure.

top