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

loObject = createobject("CkJsonArray")

Properties

DebugLogFilePath As Character

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 Boolean

Introduced in version 9.5.0.64

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

The default value is .T..

EmitCrlf As Boolean

Introduced in version 9.5.0.64

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

LastErrorHtml As Character (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 Character (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 Character (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 Boolean

Introduced in version 9.5.0.52

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

Size As Numeric (read-only)

Introduced in version 9.5.0.56

The number of JSON values in the array.

VerboseLogging As Boolean

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

Version As Character (read-only)

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

Methods

AddArrayAt(index As Numeric) As Boolean

Introduced in version 9.5.0.56

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

Returns .T. for success, .F. for failure.

Modify Parts of JSON Document

AddBoolAt(index As Numeric, value As Boolean) As Boolean

Introduced in version 9.5.0.56

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

Returns .T. for success, .F. for failure.

Modify Parts of JSON Document

AddIntAt(index As Numeric, value As Numeric) As Boolean

Introduced in version 9.5.0.56

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

Returns .T. for success, .F. for failure.

Modify Parts of JSON Document

AddNullAt(index As Numeric) As Boolean

Introduced in version 9.5.0.56

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

Returns .T. for success, .F. for failure.

Modify Parts of JSON Document

AddNumberAt(index As Numeric, numericStr As Character) As Boolean

Introduced in version 9.5.0.56

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

Returns .T. for success, .F. for failure.

Create more Complex JSON Document

Modify Parts of JSON Document

AddObjectAt(index As Numeric) As Boolean

Introduced in version 9.5.0.56

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

Returns .T. for success, .F. for failure.

Create more Complex JSON Document

Modify Parts of JSON Document

AddStringAt(index As Numeric, value As Character) As Boolean

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 .T. for success, .F. for failure.

Create more Complex JSON Document

Modify Parts of JSON Document

ArrayAt(index As Numeric) As CkJsonArray

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 .F. on failure

JSON: Nested Array

BoolAt(index As Numeric) As Boolean

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(index As Numeric) As Boolean

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 .T. for success, .F. for failure.

Modify Parts of JSON Document

Emit() As Character

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 .F. on failure

EmitSb(sb As CkStringBuilder) As Boolean

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 .T. for success, .F. for failure.

IntAt(index As Numeric) As Numeric

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

JSON: Access Array Values

IsNullAt(index As Numeric) As Boolean

Introduced in version 9.5.0.56

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

Modify Parts of JSON Document

Load(jsonArray As Character) As Boolean

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 .T. for success, .F. for failure.

Load a JsonArray

Loading and Parsing a JSON Array

LoadSb(sb As CkStringBuilder) As Boolean

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 .T. for success, .F. for failure.

Load a JsonArray

ObjectAt(index As Numeric) As CkJsonObject

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 .F. on failure

JSON: Array of Objects

Create more Complex JSON Document

Modify Parts of JSON Document

SaveLastError(path As Character) As Boolean

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns .T. for success, .F. for failure.

SetBoolAt(index As Numeric, value As Boolean) As Boolean

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 .T. for success, .F. for failure.

Modify Parts of JSON Document

SetIntAt(index As Numeric, value As Numeric) As Boolean

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 .T. for success, .F. for failure.

Modify Parts of JSON Document

SetNullAt(index As Numeric) As Boolean

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 .T. for success, .F. for failure.

SetNumberAt(index As Numeric, value As Character) As Boolean

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 .T. for success, .F. for failure.

Modify Parts of JSON Document

SetStringAt(index As Numeric, value As Character) As Boolean

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 .T. for success, .F. for failure.

Modify Parts of JSON Document

StringAt(index As Numeric) As Character

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 .F. on failure

JSON: Access Array Values

TypeAt(index As Numeric) As Numeric

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.