JsonArray Unicode C Reference Documentation

JsonArray

Current Version: 10.1.2

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

HCkJsonArrayW instance = CkJsonArrayW_Create();
// ...
CkJsonArrayW_Dispose(instance);

HCkJsonArrayW CkJsonArrayW_Create(void);

Creates an instance of the HCkJsonArrayW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkJsonArrayW_Dispose(HCkJsonArrayW handle);

Objects created by calling CkJsonArrayW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkJsonArrayW_Dispose.

Properties

DebugLogFilePath

void CkJsonArrayW_getDebugLogFilePath(HCkJsonArrayW cHandle, HCkString retval);
void CkJsonArrayW_putDebugLogFilePath(HCkJsonArrayW cHandle, const wchar_t *newVal);
const wchar_t *CkJsonArrayW_debugLogFilePath(HCkJsonArrayW cHandle);

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

Example showing how to use DebugLogFilePath.

EmitCompact

BOOL CkJsonArrayW_getEmitCompact(HCkJsonArrayW cHandle);
void CkJsonArrayW_putEmitCompact(HCkJsonArrayW cHandle, BOOL newVal);

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

BOOL CkJsonArrayW_getEmitCrlf(HCkJsonArrayW cHandle);
void CkJsonArrayW_putEmitCrlf(HCkJsonArrayW cHandle, BOOL newVal);

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

void CkJsonArrayW_getLastErrorHtml(HCkJsonArrayW cHandle, HCkString retval);
const wchar_t *CkJsonArrayW_lastErrorHtml(HCkJsonArrayW cHandle);

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.

LastErrorText

void CkJsonArrayW_getLastErrorText(HCkJsonArrayW cHandle, HCkString retval);
const wchar_t *CkJsonArrayW_lastErrorText(HCkJsonArrayW cHandle);

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 LastErrorText LastErrorText Standard Information

LastErrorXml

void CkJsonArrayW_getLastErrorXml(HCkJsonArrayW cHandle, HCkString retval);
const wchar_t *CkJsonArrayW_lastErrorXml(HCkJsonArrayW cHandle);

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.

LastMethodSuccess

BOOL CkJsonArrayW_getLastMethodSuccess(HCkJsonArrayW cHandle);
void CkJsonArrayW_putLastMethodSuccess(HCkJsonArrayW cHandle, BOOL newVal);

Indicates the success or failure of the most recent method call: TRUE means success, FALSE 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.

Size

int CkJsonArrayW_getSize(HCkJsonArrayW cHandle);

Introduced in version 9.5.0.56

The number of JSON values in the array.

VerboseLogging

BOOL CkJsonArrayW_getVerboseLogging(HCkJsonArrayW cHandle);
void CkJsonArrayW_putVerboseLogging(HCkJsonArrayW cHandle, BOOL newVal);

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

void CkJsonArrayW_getVersion(HCkJsonArrayW cHandle, HCkString retval);
const wchar_t *CkJsonArrayW_version(HCkJsonArrayW cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddArrayAt

BOOL CkJsonArrayW_AddArrayAt(HCkJsonArrayW cHandle, int index);

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

BOOL CkJsonArrayW_AddBoolAt(HCkJsonArrayW cHandle, int index, BOOL value);

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

BOOL CkJsonArrayW_AddIntAt(HCkJsonArrayW cHandle, int index, int value);

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

BOOL CkJsonArrayW_AddNullAt(HCkJsonArrayW cHandle, int index);

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

BOOL CkJsonArrayW_AddNumberAt(HCkJsonArrayW cHandle, int index, const wchar_t *numericStr);

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

BOOL CkJsonArrayW_AddObjectAt(HCkJsonArrayW cHandle, int index);

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

BOOL CkJsonArrayW_AddObjectCopyAt(HCkJsonArrayW cHandle, int index, HCkJsonObjectW jsonObj);

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

BOOL CkJsonArrayW_AddStringAt(HCkJsonArrayW cHandle, int index, const wchar_t *value);

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

BOOL CkJsonArrayW_AddUIntAt(HCkJsonArrayW cHandle, int index, unsigned long value);

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

BOOL CkJsonArrayW_AppendArrayItems(HCkJsonArrayW cHandle, HCkJsonArrayW jarr);

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

HCkJsonArrayW CkJsonArrayW_ArrayAt(HCkJsonArrayW cHandle, int index);

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 NULL on failure

More Information and Examples

JSON: Nested Array

BoolAt

BOOL CkJsonArrayW_BoolAt(HCkJsonArrayW cHandle, int index);

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

void CkJsonArrayW_Clear(HCkJsonArrayW cHandle);

Introduced in version 9.5.0.76

Deletes all array elements.

DateAt

BOOL CkJsonArrayW_DateAt(HCkJsonArrayW cHandle, int index, HCkDateTimeW dateTime);

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

BOOL CkJsonArrayW_DeleteAt(HCkJsonArrayW cHandle, int index);

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

BOOL CkJsonArrayW_DtAt(HCkJsonArrayW cHandle, int index, BOOL bLocal, HCkDtObjW dt);

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

BOOL CkJsonArrayW_Emit(HCkJsonArrayW cHandle, const wchar_t *outStr);
const wchar_t *CkJsonArrayW_emit(HCkJsonArrayW cHandle);

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.

EmitSb

BOOL CkJsonArrayW_EmitSb(HCkJsonArrayW cHandle, HCkStringBuilderW sb);

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

int CkJsonArrayW_FindObject(HCkJsonArrayW cHandle, const wchar_t *name, const wchar_t *value, BOOL caseSensitive);

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

int CkJsonArrayW_FindString(HCkJsonArrayW cHandle, const wchar_t *value, BOOL caseSensitive);

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

int CkJsonArrayW_IntAt(HCkJsonArrayW cHandle, int index);

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

BOOL CkJsonArrayW_IsNullAt(HCkJsonArrayW cHandle, int index);

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

BOOL CkJsonArrayW_Load(HCkJsonArrayW cHandle, const wchar_t *jsonArray);

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

BOOL CkJsonArrayW_LoadSb(HCkJsonArrayW cHandle, HCkStringBuilderW sb);

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

HCkJsonObjectW CkJsonArrayW_ObjectAt(HCkJsonArrayW cHandle, int index);

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 NULL on failure

More Information and Examples

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

SetBoolAt

BOOL CkJsonArrayW_SetBoolAt(HCkJsonArrayW cHandle, int index, BOOL value);

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

BOOL CkJsonArrayW_SetIntAt(HCkJsonArrayW cHandle, int index, int value);

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

BOOL CkJsonArrayW_SetNullAt(HCkJsonArrayW cHandle, int index);

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

BOOL CkJsonArrayW_SetNumberAt(HCkJsonArrayW cHandle, int index, const wchar_t *value);

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

BOOL CkJsonArrayW_SetStringAt(HCkJsonArrayW cHandle, int index, const wchar_t *value);

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

BOOL CkJsonArrayW_SetUIntAt(HCkJsonArrayW cHandle, int index, unsigned long value);

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

BOOL CkJsonArrayW_StringAt(HCkJsonArrayW cHandle, int index, const wchar_t *outStr);
const wchar_t *CkJsonArrayW_stringAt(HCkJsonArrayW cHandle, int index);

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.

More Information and Examples

JSON: Access Array Values

Swap

BOOL CkJsonArrayW_Swap(HCkJsonArrayW cHandle, int index1, int index2);

Introduced in version 9.5.0.76

Swaps the items at positions index1 and index2.

Returns TRUE for success, FALSE for failure.

TypeAt

int CkJsonArrayW_TypeAt(HCkJsonArrayW cHandle, int index);

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

unsigned long CkJsonArrayW_UIntAt(HCkJsonArrayW cHandle, int index);

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