JsonObject C Reference Documentation

JsonObject

Current Version: 10.0.0

Represents a JSON object, which contains an unordered set of name/value pairs. Each value can be a string, number, JSON object, JSON array, true, false, or null.

Create/Dispose

HCkJsonObject instance = CkJsonObject_Create();
// ...
CkJsonObject_Dispose(instance);

HCkJsonObject CkJsonObject_Create(void);

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

void CkJsonObject_Dispose(HCkJsonObject handle);

Objects created by calling CkJsonObject_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 CkJsonObject_Dispose.

Properties

DebugLogFilePath

void CkJsonObject_getDebugLogFilePath(HCkJsonObject cHandle, HCkString retval);
void CkJsonObject_putDebugLogFilePath(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_debugLogFilePath(HCkJsonObject 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.

More Information and Examples

Example showing how to use DebugLogFilePath.

DelimiterChar

void CkJsonObject_getDelimiterChar(HCkJsonObject cHandle, HCkString retval);
void CkJsonObject_putDelimiterChar(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_delimiterChar(HCkJsonObject cHandle);

Introduced in version 9.5.0.58

Sets the delimiter char for JSON paths. The default value is ".". To use Firebase style paths, set this property to "/". (This is a string property that should have a length of 1 char.)

EmitCompact

BOOL CkJsonObject_getEmitCompact(HCkJsonObject cHandle);
void CkJsonObject_putEmitCompact(HCkJsonObject cHandle, BOOL newVal);

Introduced in version 9.5.0.56

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 CkJsonObject_getEmitCrLf(HCkJsonObject cHandle);
void CkJsonObject_putEmitCrLf(HCkJsonObject cHandle, BOOL newVal);

Introduced in version 9.5.0.56

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.

I

int CkJsonObject_getI(HCkJsonObject cHandle);
void CkJsonObject_putI(HCkJsonObject cHandle, int newVal);

Introduced in version 9.5.0.56

The value of the "i" index to be used when evaluating a JSON path.

More Information and Examples

J

int CkJsonObject_getJ(HCkJsonObject cHandle);
void CkJsonObject_putJ(HCkJsonObject cHandle, int newVal);

Introduced in version 9.5.0.56

The value of the "j" index to be used when evaluating a JSON path.

K

int CkJsonObject_getK(HCkJsonObject cHandle);
void CkJsonObject_putK(HCkJsonObject cHandle, int newVal);

Introduced in version 9.5.0.56

The value of the "k" index to be used when evaluating a JSON path.

LastErrorHtml

void CkJsonObject_getLastErrorHtml(HCkJsonObject cHandle, HCkString retval);
const char *CkJsonObject_lastErrorHtml(HCkJsonObject 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.

LastErrorText

void CkJsonObject_getLastErrorText(HCkJsonObject cHandle, HCkString retval);
const char *CkJsonObject_lastErrorText(HCkJsonObject 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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkJsonObject_getLastErrorXml(HCkJsonObject cHandle, HCkString retval);
const char *CkJsonObject_lastErrorXml(HCkJsonObject 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.

LastMethodSuccess

BOOL CkJsonObject_getLastMethodSuccess(HCkJsonObject cHandle);
void CkJsonObject_putLastMethodSuccess(HCkJsonObject 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.

LowerCaseNames

BOOL CkJsonObject_getLowerCaseNames(HCkJsonObject cHandle);
void CkJsonObject_putLowerCaseNames(HCkJsonObject cHandle, BOOL newVal);

Introduced in version 9.5.0.87

If TRUE then all member names are converted to lowercase when the JSON is initially loaded by the following methods: Load, LoadBd, LoadSb, LoadFile.

The default value is FALSE.

PathPrefix

void CkJsonObject_getPathPrefix(HCkJsonObject cHandle, HCkString retval);
void CkJsonObject_putPathPrefix(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_pathPrefix(HCkJsonObject cHandle);

Introduced in version 9.5.0.76

A prefix string that is automatically added to the JSON path passed in the first argument for other methods (such as StringOf, UpdateString, SetBoolOf, SizeOfArray, etc.)

The default value is the empty string.

Size

int CkJsonObject_getSize(HCkJsonObject cHandle);

Introduced in version 9.5.0.56

The number of name/value members in this JSON object.

More Information and Examples

JSON Iterate Members

UncommonOptions

void CkJsonObject_getUncommonOptions(HCkJsonObject cHandle, HCkString retval);
void CkJsonObject_putUncommonOptions(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_uncommonOptions(HCkJsonObject cHandle);

Introduced in version 9.5.0.90

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

Utf8

BOOL CkJsonObject_getUtf8(HCkJsonObject cHandle);
void CkJsonObject_putUtf8(HCkJsonObject 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.

VerboseLogging

BOOL CkJsonObject_getVerboseLogging(HCkJsonObject cHandle);
void CkJsonObject_putVerboseLogging(HCkJsonObject 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 CkJsonObject_getVersion(HCkJsonObject cHandle, HCkString retval);
const char *CkJsonObject_version(HCkJsonObject cHandle);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddArrayAt

BOOL CkJsonObject_AddArrayAt(HCkJsonObject cHandle, int index, const char *name);

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

Create more Complex JSON Document

AddArrayCopyAt

BOOL CkJsonObject_AddArrayCopyAt(HCkJsonObject cHandle, int index, const char *name, HCkJsonArray jarr);

Introduced in version 9.5.0.82

Inserts a copy of a JSON array 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 AddArrayCopyAt Example

AddBoolAt

BOOL CkJsonObject_AddBoolAt(HCkJsonObject cHandle, int index, const char *name, 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

JSON: Miscellaneous Operations

AddIntAt

BOOL CkJsonObject_AddIntAt(HCkJsonObject cHandle, int index, const char *name, 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

Create JSON Document

AddNullAt

BOOL CkJsonObject_AddNullAt(HCkJsonObject cHandle, int index, const char *name);

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

JSON: Miscellaneous Operations

AddNumberAt

BOOL CkJsonObject_AddNumberAt(HCkJsonObject cHandle, int index, const char *name, const char *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

AddObjectAt

BOOL CkJsonObject_AddObjectAt(HCkJsonObject cHandle, int index, const char *name);

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

AddObjectCopyAt

BOOL CkJsonObject_AddObjectCopyAt(HCkJsonObject cHandle, int index, const char *name, HCkJsonObject 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 AddObjectCopyAt Example

AddStringAt

BOOL CkJsonObject_AddStringAt(HCkJsonObject cHandle, int index, const char *name, const char *value);

Introduced in version 9.5.0.56

Inserts a new string 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 JSON Document

AppendArray

HCkJsonArray CkJsonObject_AppendArray(HCkJsonObject cHandle, const char *name);

Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Important: The name is the member name, it is not a JSON path.

Returns NULL on failure

More Information and Examples

JSON AppendArray Example

AppendArrayCopy

BOOL CkJsonObject_AppendArrayCopy(HCkJsonObject cHandle, const char *name, HCkJsonArray jarr);

Introduced in version 9.5.0.82

Appends a copy of a JSON array.

Important: The name is the member name, it is not a JSON path.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON AppendArrayCopy Example

AppendBool

BOOL CkJsonObject_AppendBool(HCkJsonObject cHandle, const char *name, BOOL value);

Introduced in version 9.5.0.58

Appends a new boolean member. (This is the same as passing -1 to the AddBoolAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateBool instead.

Returns TRUE for success, FALSE for failure.

AppendInt

BOOL CkJsonObject_AppendInt(HCkJsonObject cHandle, const char *name, int value);

Introduced in version 9.5.0.58

Appends a new integer member. (This is the same as passing an index of -1 to the AddIntAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateInt instead.

Returns TRUE for success, FALSE for failure.

AppendObject

HCkJsonObject CkJsonObject_AppendObject(HCkJsonObject cHandle, const char *name);

Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Important: The name is the member name, it is not a JSON path.

Returns NULL on failure

More Information and Examples

JSON AppendObject Example

AppendObjectCopy

BOOL CkJsonObject_AppendObjectCopy(HCkJsonObject cHandle, const char *name, HCkJsonObject jsonObj);

Introduced in version 9.5.0.82

Appends a copy of a JSON object.

Important: The name is the member name, it is not a JSON path.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON AppendObjectCopy Example

AppendString

BOOL CkJsonObject_AppendString(HCkJsonObject cHandle, const char *name, const char *value);

Introduced in version 9.5.0.58

Appends a new string member. (This is the same as passing -1 to the AddStringAt method.)

Important: The name is the member name. It is not a JSON path. To append (or update) using a JSON path, call UpdateString instead.

Returns TRUE for success, FALSE for failure.

AppendStringArray

BOOL CkJsonObject_AppendStringArray(HCkJsonObject cHandle, const char *name, HCkStringTable values);

Introduced in version 9.5.0.67

Appends an array of string values.

Important: The name is the member name, it is not a JSON path.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON Append String Array

ArrayAt

HCkJsonArray CkJsonObject_ArrayAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Returns the JSON array that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns NULL on failure

More Information and Examples

Create more Complex JSON Document

ArrayOf

HCkJsonArray CkJsonObject_ArrayOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns NULL on failure

More Information and Examples

JSON: Access Array Values Modify Parts of JSON Document JSON Paths

BoolAt

BOOL CkJsonObject_BoolAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

More Information and Examples

JSON: Miscellaneous Operations

BoolOf

BOOL CkJsonObject_BoolOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

More Information and Examples

JSON: Miscellaneous Operations JSON Paths

BytesOf

BOOL CkJsonObject_BytesOf(HCkJsonObject cHandle, const char *jsonPath, const char *encoding, HCkBinData bd);

Introduced in version 9.5.0.68

Appends the binary bytes at the specified jsonPath to bd. The encoding indicates the encoding of the bytes, such as "base64", "hex", etc.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Read/Write JSON with Binary Data such as JPEG Files

Clear

void CkJsonObject_Clear(HCkJsonObject cHandle);

Introduced in version 9.5.0.76

Clears the contents of the JSON object. This is the equivalent of calling jsonObject.Load("{}")

Clone

HCkJsonObject CkJsonObject_Clone(HCkJsonObject cHandle);

Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns NULL on failure

DateOf

BOOL CkJsonObject_DateOf(HCkJsonObject cHandle, const char *jsonPath, HCkDateTime dateTime);

Introduced in version 9.5.0.73

Fills the dateTime with the date/time string located at jsonPath. 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.

More Information and Examples

JSON Date Parsing Parse a Microsoft JSON Date (MS AJAX Date)

Delete

BOOL CkJsonObject_Delete(HCkJsonObject cHandle, const char *name);

Introduced in version 9.5.0.56

Deletes the member at having the name specified by name. Note: The name is not a tag path. It is the name of a member of this JSON object.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Renaming and Deleting Members

DeleteAt

BOOL CkJsonObject_DeleteAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Renaming and Deleting Members

DeleteRecords

int CkJsonObject_DeleteRecords(HCkJsonObject cHandle, const char *arrayPath, const char *relpath, const char *value, BOOL caseSensitive);

Introduced in version 9.5.0.88

Deletes JSON records in an array where a particular field equals or matches a value pattern. Returns the number of JSON records deleted.

DtOf

BOOL CkJsonObject_DtOf(HCkJsonObject cHandle, const char *jsonPath, BOOL bLocal, HCkDtObj dt);

Introduced in version 9.5.0.73

Fills the dt with the date/time string located at jsonPath. If bLocal is TRUE, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. 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.

More Information and Examples

JSON Date Parsing

Emit

BOOL CkJsonObject_Emit(HCkJsonObject cHandle, HCkString outStr);
const char *CkJsonObject_emit(HCkJsonObject cHandle);

Introduced in version 9.5.0.56

Writes the JSON document (rooted at the caller) and returns as a string.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Pretty Print JSON (Formatter, Beautifier)

EmitBd

BOOL CkJsonObject_EmitBd(HCkJsonObject cHandle, HCkBinData bd);

Introduced in version 9.5.0.77

Emits (appends) to the contents of bd.

Returns TRUE for success, FALSE for failure.

EmitSb

BOOL CkJsonObject_EmitSb(HCkJsonObject cHandle, HCkStringBuilder sb);

Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns TRUE for success, FALSE for failure.

EmitWithSubs

BOOL CkJsonObject_EmitWithSubs(HCkJsonObject cHandle, HCkHashtable subs, BOOL omitEmpty, HCkString outStr);
const char *CkJsonObject_emitWithSubs(HCkJsonObject cHandle, HCkHashtable subs, BOOL omitEmpty);

Introduced in version 9.5.0.67

Emits the JSON document with variable substitutions applied. If omitEmpty is TRUE, then members having empty strings or empty arrays are omitted.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Using Pre-defined JSON Templates

FindObjectWithMember

HCkJsonObject CkJsonObject_FindObjectWithMember(HCkJsonObject cHandle, const char *name);

Introduced in version 9.5.0.67

Recursively searches the JSON subtree rooted at the caller's node for a JSON object containing a member having a specified name. (If the caller is the root node of the entire JSON document, then the entire JSON document is searched.) Returns the first match or NULL if not found.

Returns NULL on failure

FindRecord

HCkJsonObject CkJsonObject_FindRecord(HCkJsonObject cHandle, const char *arrayPath, const char *relPath, const char *value, BOOL caseSensitive);

Introduced in version 9.5.0.63

Finds a JSON record in an array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns NULL on failure

More Information and Examples

JSON FindRecord Example

FindRecordString

BOOL CkJsonObject_FindRecordString(HCkJsonObject cHandle, const char *arrayPath, const char *relPath, const char *value, BOOL caseSensitive, const char *retRelPath, HCkString outStr);
const char *CkJsonObject_findRecordString(HCkJsonObject cHandle, const char *arrayPath, const char *relPath, const char *value, BOOL caseSensitive, const char *retRelPath);

Introduced in version 9.5.0.63

Finds a JSON value in an record array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON FindRecordString Example

FirebaseApplyEvent

BOOL CkJsonObject_FirebaseApplyEvent(HCkJsonObject cHandle, const char *name, const char *data);

Introduced in version 9.5.0.58

Applies a Firebase event to the JSON. The data contains JSON having a format such as

{"path": "/", "data": {"a": 1, "b": 2}}

The name should be "put" or "patch".

Returns TRUE for success, FALSE for failure.

More Information and Examples

Firebase Receive Server-Sent Events (text/event-stream)

FirebasePatch

BOOL CkJsonObject_FirebasePatch(HCkJsonObject cHandle, const char *jsonPath, const char *jsonData);

Introduced in version 9.5.0.58

For each key in the jsonData, update (or add) the corresponding key in the JSON at the given jsonPath. The jsonPath is relative to this JSON object. (This is effectively applying a Firebase patch event.)

Returns TRUE for success, FALSE for failure.

More Information and Examples

Firebase JSON Put and Patch

FirebasePut

BOOL CkJsonObject_FirebasePut(HCkJsonObject cHandle, const char *jsonPath, const char *value);

Introduced in version 9.5.0.58

Inserts or replaces the value at the jsonPath. The value can contain JSON text, an integer (in decimal string format), a boolean (true/false), the keyword "null", or a quoted string.

The jsonPath is relative to this JSON object. (This is effectively applying a Firebase put event.)

Returns TRUE for success, FALSE for failure.

More Information and Examples

Firebase JSON Put and Patch

GetDocRoot

HCkJsonObject CkJsonObject_GetDocRoot(HCkJsonObject cHandle);

Introduced in version 9.5.0.56

Returns the root of the JSON document. The root can be obtained from any JSON object within the JSON document. The entire JSON document remains in memory as long as at least one JSON object is referenced by the application. When the last reference is removed, the entire JSON document is automatically dellocated.

Returns NULL on failure

More Information and Examples

Get the Root of a JSON Document

HasMember

BOOL CkJsonObject_HasMember(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.58

Returns TRUE if the item at the jsonPath exists.

Returns TRUE for success, FALSE for failure.

IndexOf

int CkJsonObject_IndexOf(HCkJsonObject cHandle, const char *name);

Introduced in version 9.5.0.56

Returns the index of the member having the given name. Returns -1 if the name is not found.

More Information and Examples

Get the Index of a JSON Member

IntAt

int CkJsonObject_IntAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

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

More Information and Examples

JSON Iterate Members

IntOf

int CkJsonObject_IntOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

More Information and Examples

JSON: Miscellaneous Operations JSON Paths Check if Integer Exists at JSON Path Demonstrates how to Handle Large Integers in JSON

IsNullAt

BOOL CkJsonObject_IsNullAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Returns the boolean value of the member having the specified index.

More Information and Examples

JSON: Miscellaneous Operations

IsNullOf

BOOL CkJsonObject_IsNullOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Returns TRUE if the value at the specified jsonPath is null. Otherwise returns FALSE.

More Information and Examples

JSON: Miscellaneous Operations JSON Paths

JsonTypeOf

int CkJsonObject_JsonTypeOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.68

Returns the type of data at the given jsonPath. 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 jsonPath.

Load

BOOL CkJsonObject_Load(HCkJsonObject cHandle, const char *json);

Introduced in version 9.5.0.56

Parses a JSON string and loads it into this JSON object to provide DOM-style access.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Load JSON Data at Path Load a JSON Array Loading and Parsing a JSON Array Understanding JSON Array vs JSON Object

LoadBd

BOOL CkJsonObject_LoadBd(HCkJsonObject cHandle, HCkBinData bd);

Introduced in version 9.5.0.77

Loads the contents of bd.

Returns TRUE for success, FALSE for failure.

LoadFile

BOOL CkJsonObject_LoadFile(HCkJsonObject cHandle, const char *path);

Introduced in version 9.5.0.56

Loads a JSON file into this JSON object. The path is the file path to the JSON file.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Load a JSON Array

LoadPredefined

BOOL CkJsonObject_LoadPredefined(HCkJsonObject cHandle, const char *name);

Introduced in version 9.5.0.67

Loads this JSON object from a predefined document having a specified name.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Using Pre-defined JSON Templates

LoadSb

BOOL CkJsonObject_LoadSb(HCkJsonObject cHandle, HCkStringBuilder sb);

Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Download a Specific GMail Message into a Chilkat Email Object

MoveMember

BOOL CkJsonObject_MoveMember(HCkJsonObject cHandle, int fromIndex, int toIndex);

Introduced in version 9.5.0.80

Move the member from fromIndex to toIndex. If toIndex equals -1, then moves the member at position fromIndex to the last position. Set toIndex = 0 to move a member to the first position.

Returns TRUE for success, FALSE for failure.

NameAt

BOOL CkJsonObject_NameAt(HCkJsonObject cHandle, int index, HCkString outStr);
const char *CkJsonObject_nameAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Returns the name of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON Iterate Members

ObjectAt

HCkJsonObject CkJsonObject_ObjectAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns NULL on failure

More Information and Examples

Create more Complex JSON Document

ObjectOf

HCkJsonObject CkJsonObject_ObjectOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns NULL on failure

More Information and Examples

JSON: Nested Objects JSON Paths

Predefine

BOOL CkJsonObject_Predefine(HCkJsonObject cHandle, const char *name);

Introduced in version 9.5.0.67

Adds or replaces this JSON to an internal global set of predefined JSON documents that can be subsequently loaded by name.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Using Pre-defined JSON Templates

Rename

BOOL CkJsonObject_Rename(HCkJsonObject cHandle, const char *oldName, const char *newName);

Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Renaming and Deleting Members

RenameAt

BOOL CkJsonObject_RenameAt(HCkJsonObject cHandle, int index, const char *name);

Introduced in version 9.5.0.56

Renames the member at index to name.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Renaming and Deleting Members

SetBoolAt

BOOL CkJsonObject_SetBoolAt(HCkJsonObject cHandle, int index, BOOL value);

Introduced in version 9.5.0.56

Sets the boolean value of the Nth member. 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

SetBoolOf

BOOL CkJsonObject_SetBoolOf(HCkJsonObject cHandle, const char *jsonPath, BOOL value);

Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Modify Parts of JSON Document JSON Paths

SetIntAt

BOOL CkJsonObject_SetIntAt(HCkJsonObject cHandle, int index, int value);

Introduced in version 9.5.0.56

Sets the integer value of the Nth member. 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

SetIntOf

BOOL CkJsonObject_SetIntOf(HCkJsonObject cHandle, const char *jsonPath, int value);

Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Modify Parts of JSON Document JSON Paths

SetNullAt

BOOL CkJsonObject_SetNullAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Sets the value of the Nth member to null. Indexing is 0-based (the 1st member is at index 0).

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Miscellaneous Operations

SetNullOf

BOOL CkJsonObject_SetNullOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Miscellaneous Operations JSON Paths

SetNumberAt

BOOL CkJsonObject_SetNumberAt(HCkJsonObject cHandle, int index, const char *value);

Introduced in version 9.5.0.56

Sets the numeric value of the Nth member. 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

JSON: Miscellaneous Operations

SetNumberOf

BOOL CkJsonObject_SetNumberOf(HCkJsonObject cHandle, const char *jsonPath, const char *value);

Introduced in version 9.5.0.56

Sets the numeric value at the specified jsonPath. The value is an integer, float, or double already converted to a string in the format desired by the application.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Miscellaneous Operations JSON Paths

SetStringAt

BOOL CkJsonObject_SetStringAt(HCkJsonObject cHandle, int index, const char *value);

Introduced in version 9.5.0.56

Sets the string value of the Nth member. 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

SetStringOf

BOOL CkJsonObject_SetStringOf(HCkJsonObject cHandle, const char *jsonPath, const char *value);

Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Modify Parts of JSON Document JSON Paths

SizeOfArray

int CkJsonObject_SizeOfArray(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.

More Information and Examples

Sort

void CkJsonObject_Sort(HCkJsonObject cHandle, BOOL ascending, BOOL caseSensitive);

Introduced in version 9.5.0.100

Sorts the JSON members by the member name.

More Information and Examples

Sort JSON Object by Member Key Name

StringAt

BOOL CkJsonObject_StringAt(HCkJsonObject cHandle, int index, HCkString outStr);
const char *CkJsonObject_stringAt(HCkJsonObject cHandle, int index);

Introduced in version 9.5.0.56

Returns the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON Iterate Members

StringOf

BOOL CkJsonObject_StringOf(HCkJsonObject cHandle, const char *jsonPath, HCkString outStr);
const char *CkJsonObject_stringOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON: Miscellaneous Operations JSON Paths JSON Paths that need Double Quotes

StringOfEquals

BOOL CkJsonObject_StringOfEquals(HCkJsonObject cHandle, const char *jsonPath, const char *value, BOOL caseSensitive);

Introduced in version 9.5.0.96

Returns TRUE if the string value at the specified jsonPath equals value. Otherwise returns FALSE

StringOfSb

BOOL CkJsonObject_StringOfSb(HCkJsonObject cHandle, const char *jsonPath, HCkStringBuilder sb);

Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns TRUE for success, FALSE for failure.

Swap

BOOL CkJsonObject_Swap(HCkJsonObject cHandle, int index1, int index2);

Introduced in version 9.5.0.76

Swaps the positions of members at index1 and index2.

Returns TRUE for success, FALSE for failure.

More Information and Examples

Swap JSON Objects

TypeAt

int CkJsonObject_TypeAt(HCkJsonObject 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.

UIntOf

unsigned long CkJsonObject_UIntOf(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.96

Returns the unsigned integer at the specified jsonPath.

UpdateBd

BOOL CkJsonObject_UpdateBd(HCkJsonObject cHandle, const char *jsonPath, const char *encoding, HCkBinData bd);

Introduced in version 9.5.0.68

Updates or appends a new string member with the encoded contents of bd. If the full path specified by jsonPath does not exist, it is automatically created as needed. The bytes contained in bd are encoded according to encoding (such as "base64", "hex", etc.)

Returns TRUE for success, FALSE for failure.

More Information and Examples

Read/Write JSON with Binary Data such as JPEG Files

UpdateBool

BOOL CkJsonObject_UpdateBool(HCkJsonObject cHandle, const char *jsonPath, BOOL value);

Introduced in version 9.5.0.63

Updates or appends a new boolean member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

UpdateInt

BOOL CkJsonObject_UpdateInt(HCkJsonObject cHandle, const char *jsonPath, int value);

Introduced in version 9.5.0.63

Updates or appends a new integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON UpdateNumber vs UpdateInt

UpdateNewArray

BOOL CkJsonObject_UpdateNewArray(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.75

Updates or appends a new and empty array at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON Insert Empty Array or Object

UpdateNewObject

BOOL CkJsonObject_UpdateNewObject(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.75

Updates or appends a new and empty JSON object at the jsonPath. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON Insert Empty Array or Object

UpdateNull

BOOL CkJsonObject_UpdateNull(HCkJsonObject cHandle, const char *jsonPath);

Introduced in version 9.5.0.65

Updates or appends a null member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

UpdateNumber

BOOL CkJsonObject_UpdateNumber(HCkJsonObject cHandle, const char *jsonPath, const char *numericStr);

Introduced in version 9.5.0.65

Updates or appends a new numeric member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON UpdateNumber vs UpdateInt

UpdateSb

BOOL CkJsonObject_UpdateSb(HCkJsonObject cHandle, const char *jsonPath, HCkStringBuilder sb);

Introduced in version 9.5.0.68

Updates or appends a new string member with the contents of sb. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

UpdateString

BOOL CkJsonObject_UpdateString(HCkJsonObject cHandle, const char *jsonPath, const char *value);

Introduced in version 9.5.0.63

Updates or appends a new string member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Important: Prior to version 9.5.0.68, the string passed in to this method did not get properly JSON escaped. This could cause problems if non-us-ascii chars are present, or if certain special chars such as quotes, CR's, or LF's are present. Version 9.5.0.68 fixes the problem.

Returns TRUE for success, FALSE for failure.

More Information and Examples

JSON UpdateString

UpdateUInt

BOOL CkJsonObject_UpdateUInt(HCkJsonObject cHandle, const char *jsonPath, unsigned long value);

Introduced in version 9.5.0.96

Updates or appends a new unsigned integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.

Returns TRUE for success, FALSE for failure.

WriteFile

BOOL CkJsonObject_WriteFile(HCkJsonObject cHandle, const char *path);

Introduced in version 9.5.0.76

Saves the JSON to a file.

Returns TRUE for success, FALSE for failure.