JsonArray Unicode C 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.

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

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

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

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
void CkJsonArrayW_getLastErrorText(HCkJsonArrayW cHandle, HCkString retval);
const wchar_t *CkJsonArrayW_lastErrorText(HCkJsonArrayW cHandle);

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
void CkJsonArrayW_getLastErrorXml(HCkJsonArrayW cHandle, HCkString retval);
const wchar_t *CkJsonArrayW_lastErrorXml(HCkJsonArrayW cHandle);

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
BOOL CkJsonArrayW_getLastMethodSuccess(HCkJsonArrayW cHandle);
void CkJsonArrayW_putLastMethodSuccess(HCkJsonArrayW cHandle, BOOL newVal);
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
int CkJsonArrayW_getSize(HCkJsonArrayW cHandle);
Introduced in version 9.5.0.56

The number of JSON values in the array.

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

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

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

top

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

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

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

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

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

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

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

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

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

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

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

top
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
top
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

top
SaveLastError
BOOL CkJsonArrayW_SaveLastError(HCkJsonArrayW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

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

top
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
top
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
top
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
top
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:

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

top