JsonArray Delphi DLL Reference Documentation

JsonArray

Current Version: 10.0.0

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.

Create/Dispose

var
myObject: HCkJsonArray;

begin
myObject := CkJsonArray_Create();

// ...

CkJsonArray_Dispose(myObject);
end;

function CkJsonArray_Create: HCkJsonArray; stdcall;

Creates an instance of the HCkJsonArray object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkJsonArray_Dispose(handle: HCkJsonArray); stdcall;

Objects created by calling CkJsonArray_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

DebugLogFilePath

procedure CkJsonArray_getDebugLogFilePath(objHandle: HCkJsonArray; outPropVal: HCkString); stdcall;
procedure CkJsonArray_putDebugLogFilePath(objHandle: HCkJsonArray; newPropVal: PWideChar); stdcall;
function CkJsonArray__debugLogFilePath(objHandle: HCkJsonArray): PWideChar; stdcall;

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:

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

EmitCompact

function CkJsonArray_getEmitCompact(objHandle: HCkJsonArray): wordbool; stdcall;
procedure CkJsonArray_putEmitCompact(objHandle: HCkJsonArray; newPropVal: wordbool); stdcall;

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.

EmitCrlf

function CkJsonArray_getEmitCrlf(objHandle: HCkJsonArray): wordbool; stdcall;
procedure CkJsonArray_putEmitCrlf(objHandle: HCkJsonArray; newPropVal: wordbool); stdcall;

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.

LastErrorHtml

procedure CkJsonArray_getLastErrorHtml(objHandle: HCkJsonArray; outPropVal: HCkString); stdcall;
function CkJsonArray__lastErrorHtml(objHandle: HCkJsonArray): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkJsonArray_getLastErrorText(objHandle: HCkJsonArray; outPropVal: HCkString); stdcall;
function CkJsonArray__lastErrorText(objHandle: HCkJsonArray): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkJsonArray_getLastErrorXml(objHandle: HCkJsonArray; outPropVal: HCkString); stdcall;
function CkJsonArray__lastErrorXml(objHandle: HCkJsonArray): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkJsonArray_getLastMethodSuccess(objHandle: HCkJsonArray): wordbool; stdcall;
procedure CkJsonArray_putLastMethodSuccess(objHandle: HCkJsonArray; newPropVal: wordbool); stdcall;

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.

Size

function CkJsonArray_getSize(objHandle: HCkJsonArray): Integer; stdcall;

Introduced in version 9.5.0.56

The number of JSON values in the array.

VerboseLogging

function CkJsonArray_getVerboseLogging(objHandle: HCkJsonArray): wordbool; stdcall;
procedure CkJsonArray_putVerboseLogging(objHandle: HCkJsonArray; newPropVal: wordbool); stdcall;

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.

Version

procedure CkJsonArray_getVersion(objHandle: HCkJsonArray; outPropVal: HCkString); stdcall;
function CkJsonArray__version(objHandle: HCkJsonArray): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddArrayAt

function CkJsonArray_AddArrayAt(objHandle: HCkJsonArray;
index: Integer): wordbool; stdcall;

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

Modify Parts of JSON Document

AddBoolAt

function CkJsonArray_AddBoolAt(objHandle: HCkJsonArray;
index: Integer;
value: wordbool): wordbool; stdcall;

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

Modify Parts of JSON Document

AddIntAt

function CkJsonArray_AddIntAt(objHandle: HCkJsonArray;
index: Integer;
value: Integer): wordbool; stdcall;

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

Modify Parts of JSON Document

AddNullAt

function CkJsonArray_AddNullAt(objHandle: HCkJsonArray;
index: Integer): wordbool; stdcall;

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

Modify Parts of JSON Document

AddNumberAt

function CkJsonArray_AddNumberAt(objHandle: HCkJsonArray;
index: Integer;
numericStr: PWideChar): wordbool; stdcall;

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.

More Information and Examples

Create more Complex JSON Document Modify Parts of JSON Document

AddObjectAt

function CkJsonArray_AddObjectAt(objHandle: HCkJsonArray;
index: Integer): wordbool; stdcall;

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.

More Information and Examples

Create more Complex JSON Document Modify Parts of JSON Document

AddObjectCopyAt

function CkJsonArray_AddObjectCopyAt(objHandle: HCkJsonArray;
index: Integer;
jsonObj: HCkJsonObject): wordbool; stdcall;

Introduced in version 9.5.0.82

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

Returns True for success, False for failure.

More Information and Examples

JSON Array AddObjectCopyAt Example

AddStringAt

function CkJsonArray_AddStringAt(objHandle: HCkJsonArray;
index: Integer;
value: PWideChar): wordbool; stdcall;

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.

More Information and Examples

Create more Complex JSON Document Modify Parts of JSON Document

AddUIntAt

function CkJsonArray_AddUIntAt(objHandle: HCkJsonArray;
index: Integer;
value: LongWord): wordbool; stdcall;

Introduced in version 9.5.0.96

Inserts a new unsigned 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.

AppendArrayItems

function CkJsonArray_AppendArrayItems(objHandle: HCkJsonArray;
jarr: HCkJsonArray): wordbool; stdcall;

Introduced in version 9.5.0.82

Appends the array items contained in jarr.

Returns True for success, False for failure.

More Information and Examples

AppendArrayItems Example

ArrayAt

function CkJsonArray_ArrayAt(objHandle: HCkJsonArray;
index: Integer): HCkJsonArray; stdcall;

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

JSON: Nested Array

BoolAt

function CkJsonArray_BoolAt(objHandle: HCkJsonArray;
index: Integer): wordbool; stdcall;

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

Clear

procedure CkJsonArray_Clear(objHandle: HCkJsonArray) stdcall;

Introduced in version 9.5.0.76

Deletes all array elements.

DateAt

function CkJsonArray_DateAt(objHandle: HCkJsonArray;
index: Integer;
dateTime: HCkDateTime): wordbool; stdcall;

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.

DeleteAt

function CkJsonArray_DeleteAt(objHandle: HCkJsonArray;
index: Integer): wordbool; stdcall;

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

Modify Parts of JSON Document

DtAt

function CkJsonArray_DtAt(objHandle: HCkJsonArray;
    index: Integer;
    bLocal: wordbool;
    dt: HCkDtObj): wordbool; stdcall;

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.

Emit

function CkJsonArray_Emit(objHandle: HCkJsonArray;
outStr: HCkString): wordbool; stdcall;
function CkJsonArray__emit(objHandle: HCkJsonArray): PWideChar; stdcall;

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 True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

EmitSb

function CkJsonArray_EmitSb(objHandle: HCkJsonArray;
sb: HCkStringBuilder): wordbool; stdcall;

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.

More Information and Examples

Emit JSON Array to StringBuilder

FindObject

function CkJsonArray_FindObject(objHandle: HCkJsonArray;
    name: PWideChar;
    value: PWideChar;
    caseSensitive: wordbool): Integer; stdcall;

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.

More Information and Examples

Find and Delete Object from JSON Array

FindString

function CkJsonArray_FindString(objHandle: HCkJsonArray;
value: PWideChar;
caseSensitive: wordbool): Integer; stdcall;

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.

IntAt

function CkJsonArray_IntAt(objHandle: HCkJsonArray;
index: Integer): Integer; stdcall;

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

JSON: Access Array Values

IsNullAt

function CkJsonArray_IsNullAt(objHandle: HCkJsonArray;
index: Integer): wordbool; stdcall;

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

Modify Parts of JSON Document

Load

function CkJsonArray_Load(objHandle: HCkJsonArray;
jsonArray: PWideChar): wordbool; stdcall;

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.

More Information and Examples

Load a JsonArray Loading and Parsing a JSON Array Understanding JSON Array vs JSON Object

LoadSb

function CkJsonArray_LoadSb(objHandle: HCkJsonArray;
sb: HCkStringBuilder): wordbool; stdcall;

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

Load a JsonArray

ObjectAt

function CkJsonArray_ObjectAt(objHandle: HCkJsonArray;
index: Integer): HCkJsonObject; stdcall;

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

More Information and Examples

JSON: Array of Objects Create more Complex JSON Document Modify Parts of JSON Document

SetBoolAt

function CkJsonArray_SetBoolAt(objHandle: HCkJsonArray;
index: Integer;
value: wordbool): wordbool; stdcall;

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

Modify Parts of JSON Document

SetIntAt

function CkJsonArray_SetIntAt(objHandle: HCkJsonArray;
index: Integer;
value: Integer): wordbool; stdcall;

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

Modify Parts of JSON Document

SetNullAt

function CkJsonArray_SetNullAt(objHandle: HCkJsonArray;
index: Integer): wordbool; stdcall;

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.

SetNumberAt

function CkJsonArray_SetNumberAt(objHandle: HCkJsonArray;
index: Integer;
value: PWideChar): wordbool; stdcall;

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

Modify Parts of JSON Document

SetStringAt

function CkJsonArray_SetStringAt(objHandle: HCkJsonArray;
index: Integer;
value: PWideChar): wordbool; stdcall;

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

Modify Parts of JSON Document

SetUIntAt

function CkJsonArray_SetUIntAt(objHandle: HCkJsonArray;
index: Integer;
value: LongWord): wordbool; stdcall;

Introduced in version 9.5.0.96

Sets the unsigned 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.

StringAt

function CkJsonArray_StringAt(objHandle: HCkJsonArray;
    index: Integer;
    outStr: HCkString): wordbool; stdcall;
function CkJsonArray__stringAt(objHandle: HCkJsonArray;
    index: Integer): PWideChar; stdcall;

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 True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

JSON: Access Array Values

Swap

function CkJsonArray_Swap(objHandle: HCkJsonArray;
index1: Integer;
index2: Integer): wordbool; stdcall;

Introduced in version 9.5.0.76

Swaps the items at positions index1 and index2.

Returns True for success, False for failure.

TypeAt

function CkJsonArray_TypeAt(objHandle: HCkJsonArray;
index: Integer): Integer; stdcall;

Introduced in version 9.5.0.58

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

string
number
object
array
boolean
null

Returns -1 if no member exists at the given index.

UIntAt

function CkJsonArray_UIntAt(objHandle: HCkJsonArray;
index: Integer): LongWord; stdcall;

Introduced in version 9.5.0.96

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