JsonArray Xojo Plugin Reference Documentation

JsonArray

Current Version: 9.5.0.73

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

Dim jsonArray As New Chilkat.JsonArray

Properties

DebugLogFilePath
DebugLogFilePath As String

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

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

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

top
EmitCompact
EmitCompact As Boolean
Introduced in version 9.5.0.64

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

The default value is True.

top
EmitCrlf
EmitCrlf As Boolean
Introduced in version 9.5.0.64

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

top
LastErrorHtml
LastErrorHtml As String (read-only)

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

top
LastErrorText
LastErrorText As String (read-only)

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

top
LastErrorXml
LastErrorXml As String (read-only)

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

top
LastMethodSuccess
LastMethodSuccess As Boolean
Introduced in version 9.5.0.52

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

top
Size
Size As Int32 (read-only)
Introduced in version 9.5.0.56

The number of JSON values in the array.

top
VerboseLogging
VerboseLogging As Boolean

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

top
Version
Version As String (read-only)

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

top

Methods

AddArrayAt
Function AddArrayAt(index As Int32) 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 True for success, False for failure.

More Information and Examples
top
AddBoolAt
Function AddBoolAt(index As Int32, 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 True for success, False for failure.

More Information and Examples
top
AddIntAt
Function AddIntAt(index As Int32, value As Int32) 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 True for success, False for failure.

More Information and Examples
top
AddNullAt
Function AddNullAt(index As Int32) 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 True for success, False for failure.

More Information and Examples
top
AddNumberAt
Function AddNumberAt(index As Int32, numericStr As String) 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 True for success, False for failure.

top
AddObjectAt
Function AddObjectAt(index As Int32) 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 True for success, False for failure.

top
AddStringAt
Function AddStringAt(index As Int32, value As String) 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 True for success, False for failure.

top
ArrayAt
Function ArrayAt(index As Int32) As Chilkat.JsonArray
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 Nil on failure

More Information and Examples
top
BoolAt
Function BoolAt(index As Int32) 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).

top
DateAt
Function DateAt(index As Int32, dateTime As Chilkat.CkDateTime) As Boolean
Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located in the Nth array element. Indexing is 0-based (the 1st member is at index 0). Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns True for success, False for failure.

top
DeleteAt
Function DeleteAt(index As Int32) 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 True for success, False for failure.

More Information and Examples
top
DtAt
Function DtAt(index As Int32, bLocal As Boolean, dt As Chilkat.DtObj) As Boolean
Introduced in version 9.5.0.73

Fills the dt with the date/time string located in the Nth array element. If bLocal is True, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Indexing is 0-based (the 1st member is at index 0). Auto-recognizes the following date/time string formats: ISO-8061 Timestamp (such as "2009-11-04T19:55:41Z"), RFC822 date/time format (such as "Wed, 18 Apr 2018 15:51:55 -0400"), or Unix timestamp integers.

Returns True for success, False for failure.

top
Emit
Function 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 Nil on failure

top
EmitSb
Function EmitSb(sb As Chilkat.StringBuilder) 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 True for success, False for failure.

top
FindObject
Function FindObject(name As String, value As String, caseSensitive As Boolean) As Int32
Introduced in version 9.5.0.73

Return the index of the first object in the array where value of the field at name matches value. name is an object member name. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is False, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

top
FindString
Function FindString(value As String, caseSensitive As Boolean) As Int32
Introduced in version 9.5.0.73

Return the index of the first matching string in the array. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is False, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.

top
IntAt
Function IntAt(index As Int32) As Int32
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).

More Information and Examples
top
IsNullAt
Function IsNullAt(index As Int32) As Boolean
Introduced in version 9.5.0.56

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

More Information and Examples
top
Load
Function Load(jsonArray As String) 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 True for success, False for failure.

top
LoadSb
Function LoadSb(sb As Chilkat.StringBuilder) 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 True for success, False for failure.

More Information and Examples
top
ObjectAt
Function ObjectAt(index As Int32) As Chilkat.JsonObject
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 Nil on failure

top
SaveLastError
Function SaveLastError(path As String) As Boolean

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

Returns True for success, False for failure.

top
SetBoolAt
Function SetBoolAt(index As Int32, 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 True for success, False for failure.

More Information and Examples
top
SetIntAt
Function SetIntAt(index As Int32, value As Int32) 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 True for success, False for failure.

More Information and Examples
top
SetNullAt
Function SetNullAt(index As Int32) 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 True for success, False for failure.

top
SetNumberAt
Function SetNumberAt(index As Int32, value As String) 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 True for success, False for failure.

More Information and Examples
top
SetStringAt
Function SetStringAt(index As Int32, value As String) 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 True for success, False for failure.

More Information and Examples
top
StringAt
Function StringAt(index As Int32) 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 Nil on failure

More Information and Examples
top
TypeAt
Function TypeAt(index As Int32) As Int32
Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

  1. string
  2. number
  3. object
  4. array
  5. boolean
  6. null
Returns -1 if no member exists at the given index.

top