JsonArray C 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
HCkJsonArray instance = CkJsonArray_Create(); // ... CkJsonArray_Dispose(instance);
Creates an instance of the HCkJsonArray object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkJsonArray_Dispose.
Properties
DebugLogFilePath
void CkJsonArray_putDebugLogFilePath(HCkJsonArray cHandle, const char *newVal);
const char *CkJsonArray_debugLogFilePath(HCkJsonArray 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:
- 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.
EmitCompact
void CkJsonArray_putEmitCompact(HCkJsonArray cHandle, BOOL newVal);
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.
topEmitCrlf
void CkJsonArray_putEmitCrlf(HCkJsonArray cHandle, BOOL newVal);
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.
topLastErrorHtml
const char *CkJsonArray_lastErrorHtml(HCkJsonArray 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.
topLastErrorText
const char *CkJsonArray_lastErrorText(HCkJsonArray 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.
LastErrorXml
const char *CkJsonArray_lastErrorXml(HCkJsonArray 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.
topLastMethodSuccess
void CkJsonArray_putLastMethodSuccess(HCkJsonArray cHandle, BOOL newVal);
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.
topSize
The number of JSON values in the array.
topUtf8
void CkJsonArray_putUtf8(HCkJsonArray cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topVerboseLogging
void CkJsonArray_putVerboseLogging(HCkJsonArray 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.
topVersion
const char *CkJsonArray_version(HCkJsonArray cHandle);
Methods
AddArrayAt
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.
AddBoolAt
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.
AddIntAt
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.
AddNullAt
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.
AddNumberAt
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.
AddObjectAt
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.
AddObjectCopyAt
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.
AddStringAt
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.
AddUIntAt
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.
topAppendArrayItems
Appends the array items contained in jarr.
Returns TRUE for success, FALSE for failure.
ArrayAt
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
BoolAt
Returns the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
topClear
Deletes all array elements.
topDateAt
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.
topDeleteAt
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.
DtAt
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.
topEmit
const char *CkJsonArray_emit(HCkJsonArray cHandle);
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.
topEmitSb
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.
FindObject
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.
FindString
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.
topIntAt
Returns the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
IsNullAt
Returns the TRUE if the Nth array element is null, otherwise returns FALSE. Indexing is 0-based (the 1st member is at index 0).
Load
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.
LoadSb
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.
ObjectAt
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
SetBoolAt
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.
SetIntAt
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.
SetNullAt
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.
topSetNumberAt
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.
SetStringAt
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.
SetUIntAt
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.
topStringAt
const char *CkJsonArray_stringAt(HCkJsonArray cHandle, int index);
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.
Swap
TypeAt
Returns the type of data at the given index. Possible return values are:
- string
- number
- object
- array
- boolean
- null
UIntAt
Returns the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
top