JsonObject ActiveX Reference Documentation

JsonObject

Current Version: 11.5.0

Chilkat.JsonObject

Load, navigate, create, modify, search, sort, and emit JSON objects.

Chilkat.JsonObject provides DOM-style access to JSON objects. It can load, inspect, modify, create, search, sort, emit, and save JSON data. It supports path-based access, index-based member access, automatic creation of nested paths, object and array references, Firebase-style updates, record searches, date/time conversion, binary data encoding, variable substitution, and optional secure secret resolution.

Load and emit JSON

Load JSON from strings, files, buffers, or Chilkat objects, then emit the result as compact or pretty-formatted JSON.

Path-based navigation

Read and update nested values using JSON paths, with support for automatically creating missing object or array paths.

Member access

Access object members by name or index, inspect member types, retrieve values, and remove or rename members as needed.

Nested objects and arrays

Work directly with child JsonObject and JsonArray references to navigate and modify complex JSON structures.

Search and transform

Search records, sort object members, perform Firebase-style updates, and prepare JSON for API requests or application storage.

Special value handling

Handle date/time values, binary data encodings, exact numeric text, variable substitution, and secure secret resolution.

Common pattern: Load or create a JsonObject, navigate named members and nested paths, retrieve child arrays as JsonArray objects when ordered lists are encountered, update values as needed, then emit or save the final JSON. Use JsonObject for named JSON members and JsonArray for ordered lists.

For an extended overview, see JsonObject Class Overview.

Object Creation

Note:
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")

(VBA, such as Excel)
Dim obj As New ChilkatJsonObject
See How to Use ActiveX in Excel

(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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing 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

Specifies the character used to separate object-member names in Chilkat JSON paths. The default is .. Set it to / for Firebase-style paths. This property should contain exactly one character.

Arrays in paths: Array indexes continue to use square brackets, such as orders[0].id. If a member name itself contains a path-separator character, quote that path component with double quotes.

top
EmitCompact
EmitCompact As Long
Introduced in version 9.5.0.56

Controls whether emitted JSON is compact or pretty-printed. The default is 1.

1Emit a compact representation with no extra formatting whitespace.
0Emit indented, human-readable JSON.
JSON semantics: Formatting whitespace does not change the JSON data. Use compact output for transport/storage and pretty output for diagnostics or human review.

top
EmitCrLf
EmitCrLf As Long
Introduced in version 9.5.0.56

Controls line endings when pretty-printed JSON is emitted (EmitCompact = 0). The default is 1.

1Use CRLF line endings.
0Use LF line endings.
Compact output: This setting has no effect when EmitCompact is 1 because compact JSON is emitted without formatting line breaks.

top
EnableSecrets
EnableSecrets As Long
Introduced in version 11.5.0

Enables automatic resolution of Chilkat secret specification strings for supported string-setting methods. The default is 0. When enabled, a value beginning with !! can identify a credential stored in Windows Credential Manager or Apple Keychain instead of embedding the literal secret in application code.

Secret specification format: !![appName|]service[|domain]|username.

This feature applies to AddStringAt, AppendString, SetStringAt, SetStringOf, UpdateSb, and UpdateString.

Security: Secret resolution changes where the string value comes from; the resulting JSON member still contains the resolved value. Avoid emitting or logging JSON that contains credentials unless that exposure is explicitly intended.

More Information and Examples
More Detailed Information About EnableSecrets
top
I
I As Long
Introduced in version 9.5.0.56

Supplies the integer substituted for i when a JSON path contains an array index such as [i]. This is useful for loop-based navigation without constructing a new path string for every iteration.

Related properties: The J and K properties provide the same substitution behavior for [j] and [k].

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

Supplies the integer substituted for j when a JSON path contains [j]. It is commonly used with nested-array paths such as matrix[i][j].

top
K
K As Long
Introduced in version 9.5.0.56

Supplies the integer substituted for k when a JSON path contains [k]. It can be combined with I and J for deeper nested-array traversal.

top
LastBinaryResult
LastBinaryResult As Variant (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples
Concept of LastErrorTextLastErrorText Standard Information
top
LastErrorXml
LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

top
LastStringResult
LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

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, member names are converted to lowercase while JSON is loaded by Load, LoadBd, LoadSb, or LoadFile. The default is 0.

Important: This changes member names in the parsed document; it is not merely a case-insensitive lookup mode. Use it only when normalizing names is intentional.

top
PathPrefix
PathPrefix As String
Introduced in version 9.5.0.76

Specifies a path prefix automatically prepended to JSON paths passed to path-based methods such as StringOf, ObjectOf, UpdateString, SetBoolOf, and SizeOfArray. The default is the empty string.

Use case: Set a prefix when many operations target the same nested object. The individual method calls can then use paths relative to that prefix.

More Information and Examples
(AutoIt) JSON PathPrefix Example(Classic ASP) JSON PathPrefix Example(PowerBuilder) JSON PathPrefix Example(SQL Server) JSON PathPrefix Example(VBScript) JSON PathPrefix Example(Visual Basic 6.0) JSON PathPrefix Example(Visual FoxPro) JSON PathPrefix Example
top
Size
Size As Long (read-only)
Introduced in version 9.5.0.56

Returns the number of direct name/value members in this JSON object. Nested members inside child objects are not included.

JSON objects and order: RFC 8259 defines a JSON object as an unordered collection of name/value pairs. Chilkat preserves a member order so index-based APIs and deterministic emission are possible, but interoperable application logic should generally use member names rather than depend on object order.

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

Provides a catch-all string for uncommon, implementation-specific options. The default is the empty string and it should normally remain empty.

Recommendation: Do not invent option keywords. Set this property only when a specific JsonObject option is documented by Chilkat or provided by Chilkat support.

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 "10.1.0"

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 JSON array member named name at the zero-based member position index. The new array is empty.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 new JSON array member named name at the zero-based member position index. The array value is copied from jarr; subsequent changes to the source array do not modify the inserted copy.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 JSON boolean member named name at the zero-based member position index. The value is taken from value.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 JSON number member named name at the zero-based member position index. The integer value is emitted as a JSON number, not as a quoted string.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 JSON null member named name at the zero-based member position index.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 JSON number member named name at the zero-based member position index. The numericStr argument supplies the exact JSON numeric text to store.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.
Exact numeric text: Use this method when lexical form or precision matters, for example 12345678901234567890, 1.2500, or scientific notation. The supplied text must be valid JSON number syntax; JSON does not permit NaN or infinity.

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 JSON object member named name at the zero-based member position index. The new object is empty.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 new JSON object member named name at the zero-based member position index. The object value is copied from jsonObj; the inserted value is independent of the source.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 JSON string member named name at the zero-based member position index. The value is stored as a JSON string and is escaped as needed when emitted.

0Insert as the first member.
-1Append as the last member.
nInsert at zero-based position n.
Member name vs. JSON path: name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.

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 JSON array member named name to this object. The newly appended array is empty and the returned JsonArray references that array in this document, so changes made through it modify the same JSON tree.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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
AppendArray2
AppendArray2(name As String, jarr As ChilkatJsonArray) As Long
Introduced in version 11.0.0

Appends a new JSON array member named name to this object. A new empty array is created and jarr is updated to reference it. The method returns 1 on success.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

top
AppendArrayCopy
AppendArrayCopy(name As String, jarr As ChilkatJsonArray) As Long
Introduced in version 9.5.0.82

Appends a new JSON array member named name to this object. The array is copied from jarr, so the appended array is independent of the source array.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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 JSON boolean member named name to this object. The value is taken from value.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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 JSON number member named name to this object. The integer value is stored as a JSON number.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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 JSON object member named name to this object. The newly appended object is empty and the returned JsonObject references that object in this document.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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
AppendObject2
AppendObject2(name As String, jsonObj As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Appends a new JSON object member named name to this object. A new empty object is created and jsonObj is updated to reference it. The method returns 1 on success.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

top
AppendObjectCopy
AppendObjectCopy(name As String, jsonObj As ChilkatJsonObject) As Long
Introduced in version 9.5.0.82

Appends a new JSON object member named name to this object. The object is copied from jsonObj, so the appended object is independent of the source object.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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 JSON string member named name to this object. The value is JSON-escaped as needed when emitted.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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 a new JSON array member named name to this object. The array is populated with the strings contained in values.

Member name vs. JSON path: name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.

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 stored in the member at zero-based position index. The returned JsonArray references the existing array in the same document; it is not a detached copy.

Type requirement: The member at index must be an array. Use TypeAt when the member type is not already known.

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
ArrayAt2
ArrayAt2(ByVal index As Long, jarr As ChilkatJsonArray) As Long
Introduced in version 11.0.0

Updates jarr to reference the JSON array stored at zero-based member position index and returns 1 on success.

Returns 1 for success, 0 for failure.

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

Returns the JSON array at jsonPath. The returned JsonArray references the existing array in the same document, so modifications through it are reflected in the parent JSON.

JSON paths: Paths are relative to this object and may include object-member separators and array indexes, for example orders[0].items.

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
ArrayOf2
ArrayOf2(jsonPath As String, jarr As ChilkatJsonArray) As Long
Introduced in version 11.1.0

Updates jarr to reference the JSON array at jsonPath and returns 1 on success.

Returns 1 for success, 0 for failure.

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

Returns the boolean value of the member at zero-based position index.

Indexing: Member indexes are based on the order maintained by this JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.
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 value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.

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

Reads the string value at jsonPath, decodes it using encoding (for example, base64 or hex), and appends the resulting bytes to bd.

Binary-in-JSON convention: The JSON member itself is text. The encoding argument tells Chilkat how that text represents the original bytes.

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

Removes all members from this JSON object, leaving an empty object equivalent to {}.

top
CopyRef
CopyRef(jsonObj As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Updates jsonObj so that it references the same JSON object as the caller. No JSON data is copied.

Shared state: After this call, modifications through either reference affect the same underlying JSON object.

Returns 1 for success, 0 for failure.

top
DateOf
DateOf(jsonPath As String, dateTime As CkDateTime) As Long
Introduced in version 9.5.0.73

Parses the date/time value at jsonPath and loads the result into dateTime. Recognized forms include ISO 8601 timestamps (for example, 2009-11-04T19:55:41Z), RFC 822-style date/time strings, and Unix timestamp integers.

JSON has no native date type: Dates in JSON are application conventions, usually represented as strings or numbers. This method recognizes common conventions and converts them to CkDateTime.

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 direct member named name from this JSON object.

Not a path: name is a member name, not a JSON path. Use a path-based operation when deleting or replacing a nested value requires navigation first.

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 zero-based position index. Members after the deleted position shift toward the beginning.

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 every object record in the array at arrayPath whose value at relative path relpath equals or wildcard-matches value. The caseSensitive argument controls matching. Returns the number of records deleted.

top
DtOf
DtOf(jsonPath As String, ByVal bLocal As Long, dt As DtObj) As Long
Introduced in version 9.5.0.73

Parses the date/time value at jsonPath into dt. If bLocal is 1, the destination receives local date/time fields; otherwise it receives UTC/GMT fields. Recognized inputs include ISO 8601 timestamps, RFC 822-style date/time strings, and 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

Serializes the JSON document rooted at this object and returns the JSON text. Formatting is controlled by EmitCompact and, for pretty output, EmitCrLf.

Object member order: Chilkat emits members in its maintained order, but JSON object ordering is not semantically significant under RFC 8259.

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

Serializes this JSON and appends the resulting bytes to bd.

Append behavior: Existing data in the destination BinData is preserved.

Returns 1 for success, 0 for failure.

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

Serializes this JSON and appends the resulting text to sb. Formatting follows EmitCompact and EmitCrLf.

Append behavior: Existing text in the destination StringBuilder is preserved; the emitted JSON is added after it.

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

Serializes the JSON after substituting variables from subs into template strings. A placeholder such as {$name} is replaced by the corresponding hashtable value. Prefixing the variable name with i., as in {$i.count}, emits the substituted value as a JSON integer instead of a quoted string.

If omitEmpty is 1, members whose substituted result is an empty string or empty array are omitted from the emitted JSON.

Template reuse: This method does not require rebuilding the JSON template. It is commonly paired with Predefine and LoadPredefined when the same JSON shape is emitted repeatedly with different values.

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 this JSON subtree for the first JSON object containing a direct member named name. Returns that object, or Nothing if no matching object is found.

Returns Nothing on failure

top
FindObjectWithMember2
FindObjectWithMember2(name As String, jsonObj As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Recursively searches this JSON subtree for the first object containing a direct member named name. On success, jsonObj is updated to reference the matching object and the method returns 1.

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

Searches the JSON array at arrayPath for the first object whose value at relative path relPath equals or wildcard-matches value. The caseSensitive argument controls string comparison. Returns the matching record object.

Wildcard matching: The search value may contain * to match zero or more characters. relPath is evaluated relative to each record object in the array.

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
FindRecord2
FindRecord2(arrayPath As String, relPath As String, value As String, ByVal caseSensitive As Long, jsonObj As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Searches the JSON array at arrayPath using the same matching rules as FindRecord. On success, jsonObj is updated to reference the first matching record and the method returns 1.

Reference semantics: The destination references the record in the original JSON document; changes made through jsonObj modify that record.

Returns 1 for success, 0 for failure.

top
FindRecordString
FindRecordString(arrayPath As String, relPath As String, value As String, ByVal caseSensitive As Long, retRelPath As String) As String
Introduced in version 9.5.0.63

Searches the JSON array at arrayPath for the first record whose relPath value equals or wildcard-matches value, then returns the value at retRelPath from that same record as a string.

Typical use: This is useful for lookups such as “find the record where Name is Advertising and return its Id.” The * wildcard may be used in value.

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 Realtime Database event to this JSON object. name should be put or patch, and data should contain event JSON such as {"path":"/","data":{"a":1,"b":2}}.

Purpose: This method is useful when maintaining a local JSON representation from Firebase server-sent events: put replaces the value at a path, while patch updates individual child keys.

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) Firebase Receive Server-Sent Events (text/event-stream)(PowerBuilder) 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

Applies Firebase-style patch semantics at jsonPath. jsonData must contain a JSON object; each key in that object updates or adds the corresponding key at the target path.

Relative path: jsonPath is relative to this JsonObject.

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

Applies Firebase-style put semantics at jsonPath, replacing or inserting the value at that path. value is JSON text and may represent an object, array, number, boolean, null, or a quoted JSON string.

Quoted strings: To store a string through this method, value must contain a valid JSON string literal, including its surrounding double quotes. Use UpdateString when you already have an ordinary application string.

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 a JsonObject reference to the root object of the JSON document containing this object. This can be called from any nested object reference.

Shared document lifetime: Nested JsonObject references share the same underlying JSON document. The document remains available while at least one such reference is retained by the application.

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
GetDocRoot2
GetDocRoot2(docRoot As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Updates docRoot to reference the root object of the JSON document containing the caller and returns 1 on success.

Reference semantics: The destination is another reference into the same underlying document; it is not a copy.

Returns 1 for success, 0 for failure.

top
HasMember
HasMember(jsonPath As String) As Long
Introduced in version 9.5.0.58

Returns 1 if a value exists at jsonPath; otherwise returns 0.

Missing vs. null: A member whose JSON value is null still exists. Use IsNullOf to test specifically for JSON null.

Returns 1 for success, 0 for failure.

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

Returns the zero-based position of the direct member named name, or -1 if that member name is not found.

Not a path: name is searched only among the direct members of this object.
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 member at zero-based position index.

Indexing: Member indexes are based on the order maintained by this JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.
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 value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.

Large numbers: Use StringOf or the exact numeric-text APIs when a JSON integer may exceed the range of the language binding's integer type.
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 1 if the member at zero-based position index has the JSON value 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
top
IsNullOf
IsNullOf(jsonPath As String) As Long
Introduced in version 9.5.0.56

Returns 1 if the value at jsonPath is the JSON literal null; otherwise returns 0.

Null is a value: JSON null is different from a missing member and from an empty string. Use HasMember when existence must be tested separately.
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 an integer identifying the JSON type of the value at jsonPath. Returns -1 if no member exists at that path.

1string
2number
3object
4array
5boolean
6null
top
Load
Load(json As String) As Long
Introduced in version 9.5.0.56

Parses the JSON text in json and loads the parsed data into this object for DOM-style access and modification.

JSON data model: JSON values are strings, numbers, booleans, null, objects, or arrays. Object member names should be unique for interoperable JSON; RFC 8259 notes that consumers differ in how duplicate names are handled.

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

Parses JSON from the bytes contained in bd and loads it into this object.

Returns 1 for success, 0 for failure.

top
LoadFile
LoadFile(path As String) As Long
Introduced in version 9.5.0.56

Reads JSON text from the file at path, parses it, and loads the result into this object.

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 object from the predefined JSON document identified by name. Predefined documents are created with Predefine.

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

Parses JSON from the current contents of sb and loads it into this 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
MakeCopy
MakeCopy(json As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Copies this JSON object into json. The destination receives an independent JSON copy rather than another reference to the same underlying object.

Copy vs. reference: Use CopyRef when two JsonObject instances should refer to the same JSON object instead of duplicating its data.

Returns 1 for success, 0 for failure.

top
MoveMember
MoveMember(ByVal fromIndex As Long, ByVal toIndex As Long) As Long
Introduced in version 9.5.0.80

Moves the direct member at zero-based position fromIndex to toIndex. Use toIndex = 0 to move it first or -1 to move it last.

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 member at zero-based position index. Use this with Size and TypeAt to iterate through an object's direct members.

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
NewArrayOf
NewArrayOf(path As String, jArr As String) As Long
Introduced in version 11.4.0

Creates a JSON array at path and loads that array from the JSON text in jArr. The supplied text should represent a JSON array.

Difference from UpdateNewArray: UpdateNewArray creates an empty array. NewArrayOf creates the array and immediately populates it from JSON text.

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) Example: JsonObject.NewArrayOf method(Classic ASP) Example: JsonObject.NewArrayOf method(PowerBuilder) Example: JsonObject.NewArrayOf method(SQL Server) Example: JsonObject.NewArrayOf method(VBScript) Example: JsonObject.NewArrayOf method(Visual Basic 6.0) Example: JsonObject.NewArrayOf method(Visual FoxPro) Example: JsonObject.NewArrayOf method
top
NewObjectOf
NewObjectOf(path As String, jObj As String) As Long
Introduced in version 11.4.0

Creates a JSON object at path and loads that object from the JSON text in jObj. The supplied text should represent a JSON object.

Difference from UpdateNewObject: UpdateNewObject creates an empty object. NewObjectOf creates the object and immediately populates it from JSON text.

Returns 1 for success, 0 for failure.

More Information and Examples
(AutoIt) Example: JsonObject.NewObjectOf method(Classic ASP) Example: JsonObject.NewObjectOf method(PowerBuilder) Example: JsonObject.NewObjectOf method(SQL Server) Example: JsonObject.NewObjectOf method(VBScript) Example: JsonObject.NewObjectOf method(Visual Basic 6.0) Example: JsonObject.NewObjectOf method(Visual FoxPro) Example: JsonObject.NewObjectOf method
top
ObjectAt
ObjectAt(ByVal index As Long) As ChilkatJsonObject
Introduced in version 9.5.0.56

Returns the JSON object stored in the member at zero-based position index. The returned JsonObject references the existing child object in the same document; changes made through it modify that document.

Type requirement: The member at index must be a JSON object. Use TypeAt when the type is not already known.

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
ObjectAt2
ObjectAt2(ByVal index As Long, jsonObj As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Updates jsonObj to reference the JSON object stored at zero-based member position index and returns 1 on success.

Returns 1 for success, 0 for failure.

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

Returns the JSON object at jsonPath. The returned object is a live reference into the same JSON document, not a copy.

Relative paths: A path is evaluated relative to the current object. Use GetDocRoot when access must start from the document root.

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
ObjectOf2
ObjectOf2(jsonPath As String, jsonObj As ChilkatJsonObject) As Long
Introduced in version 11.0.0

Updates jsonObj to reference the JSON object at jsonPath and returns 1 on success.

Returns 1 for success, 0 for failure.

top
Predefine
Predefine(name As String) As Long
Introduced in version 9.5.0.67

Stores this JSON document in Chilkat's internal global collection of predefined JSON documents under name. If the name already exists, the predefined value is replaced.

Template use: After predefining a document, another JsonObject can load it by name with LoadPredefined.

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 direct member oldName to newName. The member value and its position are otherwise unchanged.

JSON interoperability: JSON object member names should be unique. Avoid renaming a member to a name already used by another member unless duplicate names are intentionally required.

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 zero-based position index to name. The member value is not changed.

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 member at zero-based position index to a JSON boolean value.

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 value at jsonPath to a JSON boolean value.

Set vs. Update: Use UpdateBool when missing objects or array positions along the path should be created automatically.

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 member at zero-based position index to a JSON number value. The integer is emitted as a JSON number.

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 value at jsonPath to an integer JSON number.

Set vs. Update: Use UpdateInt when missing objects or array positions along the path should be created automatically.

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 member at zero-based position index to a JSON null value.

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 jsonPath to a JSON null value.

Set vs. Update: Use UpdateNull when missing objects or array positions along the path should be created automatically.

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 member at zero-based position index to a JSON number value. The value argument is the exact textual representation of the JSON number.

JSON number syntax: The text may contain an integer, fraction, or exponent. It must be valid JSON number syntax; leading zeros (except for zero itself), NaN, and infinity are not valid JSON numbers.

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 value at jsonPath to a JSON number value. The value argument supplies the exact textual form of the JSON number.

Set vs. Update: Use UpdateNumber when missing objects or array positions along the path should be created automatically.
Precision: Using numeric text avoids an intermediate conversion through a floating-point type and can therefore preserve large integers or application-specific decimal formatting.

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 member at zero-based position index to a JSON string value. The string is escaped as required when JSON is emitted.

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 value at jsonPath to a JSON string value. The string is escaped as required when JSON is emitted.

Set vs. Update: Use UpdateString when missing objects or array positions along the path should be created automatically.

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 number of elements in the JSON array at jsonPath. Returns -1 if the path does not resolve to an existing 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 this object's direct members by member name. ascending selects ascending or descending order, and caseSensitive controls how names are compared.

JSON semantics: Member ordering is not significant to JSON consumers, but sorting can make emitted JSON deterministic and easier to compare or review.
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 member at zero-based position index.

Indexing: Member indexes are based on the order maintained by this JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.
Non-string values: StringOf can also provide textual representations of scalar JSON values such as numbers, booleans, and null; use the type-specific methods when the JSON type itself matters.

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 value at jsonPath as text. For a JSON string, the string value is returned. Scalar non-string values such as numbers, booleans, and null are returned using their JSON textual representation.

Type-sensitive code: Use JsonTypeOf, IntOf, BoolOf, or IsNullOf when the distinction between JSON types is important.

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(AutoIt) Using JSON StringOf with Non-String Members(Classic ASP) Using JSON StringOf with Non-String Members(PowerBuilder) Using JSON StringOf with Non-String Members(SQL Server) Using JSON StringOf with Non-String Members(VBScript) Using JSON StringOf with Non-String Members(Visual Basic 6.0) Using JSON StringOf with Non-String Members(Visual FoxPro) Using JSON StringOf with Non-String Members
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 textual value at jsonPath equals value according to the caseSensitive setting; otherwise returns 0.

top
StringOfSb
StringOfSb(jsonPath As String, sb As ChilkatStringBuilder) As Long
Introduced in version 9.5.0.68

Retrieves the value at jsonPath as text and appends it to sb.

Append behavior: Existing contents of the destination StringBuilder are preserved.

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 the direct members at zero-based indexes index1 and index2. Member names and values are unchanged.

Ordering: JSON object order is not semantically significant, but Chilkat preserves an order for index-based access and emission.

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 an integer identifying the JSON type of the member at zero-based position index. Returns -1 if no member exists at that index.

1string
2number
3object
4array
5boolean
6null
top
UIntOf
UIntOf(jsonPath As String) As Long
Introduced in version 9.5.0.96

Returns the unsigned integer value at jsonPath.

top
UpdateBd
UpdateBd(jsonPath As String, encoding As String, bd As ChilkatBinData) As Long
Introduced in version 9.5.0.68

Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The bytes in bd are first encoded according to encoding (for example, base64 or hex) and the encoded text is stored as the JSON string value.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.
Binary data in JSON: JSON has no native byte-array type. Binary content must therefore be represented using a textual encoding agreed upon by the producer and consumer.

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 the value at jsonPath to a JSON boolean value, or creates the member and any missing path components as needed.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

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 the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The integer value is stored as a JSON number.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

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

Creates or replaces the value at jsonPath with a new empty JSON array. Missing path components are created automatically 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

Creates or replaces the value at jsonPath with a new empty JSON object. Missing path components are created automatically 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 the value at jsonPath to a JSON null value, or creates the member and any missing path components as needed.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

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 the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The numericStr argument is stored as the exact textual representation of the JSON number.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.
When to use: Use UpdateNumber instead of UpdateInt for decimal/exponent forms, very large integers, or when preserving exact numeric text is important.

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 the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The new string value is taken from the contents of sb.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

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 the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The supplied string is JSON-escaped as needed.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.
Version note: Chilkat versions prior to 9.5.0.68 did not correctly escape all characters for this method. Version 9.5.0.68 and later correct that behavior.

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 the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The unsigned integer is stored as a JSON number.

Path-based operation: jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.

Returns 1 for success, 0 for failure.

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

Serializes this JSON and writes it to the file at path. Output formatting follows EmitCompact and EmitCrLf.

Returns 1 for success, 0 for failure.

top

Deprecated

Clone
Clone() As ChilkatJsonObject
Introduced in version 9.5.0.66
This method is deprecated and replaced by MakeCopy

Deprecated. Use MakeCopy instead. Returns an independent copy of this JSON object.

Returns Nothing on failure

top