JsonArray ActiveX Reference Documentation

JsonArray

Represents a JSON array, which contains an ordered list of JSON values, where each value can be a string, number, JSON object, JSON array, true, false, or null.

Object Creation

In Chilkat versions prior to v9.5.0.64, the JSON array should never be explicitly created by an application.
It must be created by an already-existing JSON object (or array) by calling the AddArrayAt method, and then 
fetching it via the ArrayAt method.

(Visual Basic 6.0) Dim obj As New ChilkatJsonArray (ASP) set obj = Server.CreateObject("Chilkat_9_5_0.JsonArray") (VBScript) set obj = CreateObject("Chilkat_9_5_0.JsonArray") (Delphi) obj := TChilkatJsonArray.Create(Self); (FoxPro) loObject = CreateObject('Chilkat_9_5_0.JsonArray') (PowerBuilder) lole_object = create oleobject li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.JsonArray") (SQL Server) EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonArray', @obj OUT (Javascript) var obj = new ActiveXObject("Chilkat_9_5_0.JsonArray");

Properties

DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

EmitCompact As Long

Introduced in version 9.5.0.64

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

The default value is 1.

EmitCrlf As Long

Introduced in version 9.5.0.64

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.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

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

LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

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

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

Size As Long (read-only)

Introduced in version 9.5.0.56

The number of JSON values in the array.

VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version As String (read-only)

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

Methods

AddArrayAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

AddBoolAt(ByVal index As Long, ByVal value As Long) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

AddIntAt(ByVal index As Long, ByVal value As Long) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

AddNullAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

AddNumberAt(ByVal index As Long, numericStr As String) As Long

Introduced in version 9.5.0.56

Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

AddObjectAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

AddStringAt(ByVal index As Long, value As String) As Long

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

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 array element. Indexing is 0-based (the 1st member is at index 0).

Returns Nothing on failure

(Classic ASP) JSON: Nested Array

(Visual FoxPro) JSON: Nested Array

(PowerBuilder) JSON: Nested Array

(SQL Server) JSON: Nested Array

(Visual Basic 6.0) JSON: Nested Array

(VBScript) JSON: Nested Array

BoolAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

Returns the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

DeleteAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

Deletes the array element at the given index. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

Emit() As String

Introduced in version 9.5.0.58

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

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns Nothing on failure

EmitSb(sb As ChilkatStringBuilder) As Long

Introduced in version 9.5.0.65

Writes the JSON array to the sb.

Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.

Returns 1 for success, 0 for failure.

IntAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

Returns the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

(Classic ASP) JSON: Access Array Values

(Visual FoxPro) JSON: Access Array Values

(PowerBuilder) JSON: Access Array Values

(SQL Server) JSON: Access Array Values

(Visual Basic 6.0) JSON: Access Array Values

(VBScript) JSON: Access Array Values

IsNullAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

Returns the 1 if the Nth array element is null, otherwise returns 0. Indexing is 0-based (the 1st member is at index 0).

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

Load(jsonArray As String) As Long

Introduced in version 9.5.0.64

Loads a JSON array from a string. A JSON array must begin with a "[" and end with a "]".

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

Returns 1 for success, 0 for failure.

(Classic ASP) Load a JsonArray

(Visual FoxPro) Load a JsonArray

(PowerBuilder) Load a JsonArray

(SQL Server) Load a JsonArray

(Visual Basic 6.0) Load a JsonArray

(VBScript) Load a JsonArray

(Classic ASP) Loading and Parsing a JSON Array

(Visual FoxPro) Loading and Parsing a JSON Array

(PowerBuilder) Loading and Parsing a JSON Array

(SQL Server) Loading and Parsing a JSON Array

(Visual Basic 6.0) Loading and Parsing a JSON Array

(VBScript) Loading and Parsing a JSON Array

LoadSb(sb As ChilkatStringBuilder) As Long

Introduced in version 9.5.0.64

Loads a JSON array from a StringBuilder. A JSON array must begin with a "[" and end with a "]".

Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.

Returns 1 for success, 0 for failure.

(Classic ASP) Load a JsonArray

(Visual FoxPro) Load a JsonArray

(PowerBuilder) Load a JsonArray

(SQL Server) Load a JsonArray

(Visual Basic 6.0) Load a JsonArray

(VBScript) Load a JsonArray

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 array element. Indexing is 0-based (the 1st member is at index 0).

Returns Nothing on failure

(Classic ASP) JSON: Array of Objects

(Visual FoxPro) JSON: Array of Objects

(PowerBuilder) JSON: Array of Objects

(SQL Server) JSON: Array of Objects

(Visual Basic 6.0) JSON: Array of Objects

(VBScript) JSON: Array of Objects

(Classic ASP) Create more Complex JSON Document

(Visual FoxPro) Create more Complex JSON Document

(PowerBuilder) Create more Complex JSON Document

(SQL Server) Create more Complex JSON Document

(Visual Basic 6.0) Create more Complex JSON Document

(VBScript) Create more Complex JSON Document

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

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 array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

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 array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

SetNullAt(ByVal index As Long) As Long

Introduced in version 9.5.0.56

Sets the Nth array element to the value of null. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

SetNumberAt(ByVal index As Long, value As String) As Long

Introduced in version 9.5.0.56

Sets the numeric value of the Nth array element. The value is an integer, float, or double already converted to a string in the format desired by the application. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

SetStringAt(ByVal index As Long, value As String) As Long

Introduced in version 9.5.0.56

Sets the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns 1 for success, 0 for failure.

(Classic ASP) Modify Parts of JSON Document

(Visual FoxPro) Modify Parts of JSON Document

(PowerBuilder) Modify Parts of JSON Document

(SQL Server) Modify Parts of JSON Document

(Visual Basic 6.0) Modify Parts of JSON Document

(VBScript) Modify Parts of JSON Document

StringAt(ByVal index As Long) As String

Introduced in version 9.5.0.56

Returns the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).

Returns Nothing on failure

(Classic ASP) JSON: Access Array Values

(Visual FoxPro) JSON: Access Array Values

(PowerBuilder) JSON: Access Array Values

(SQL Server) JSON: Access Array Values

(Visual Basic 6.0) JSON: Access Array Values

(VBScript) JSON: Access Array Values

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.