CkJsonObjectW Unicode C++ Reference Documentation

CkJsonObjectW

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.

Object Creation

// Local variable on the stack
CkJsonObjectW obj;

// Dynamically allocate/delete
CkJsonObjectW *pObj = new CkJsonObjectW();
// ...
delete pObj;

Properties

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

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 get_DelimiterChar(CkString &str);
const wchar_t *delimiterChar(void);
void put_DelimiterChar(const wchar_t *str);

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 get_EmitCompact(void);
void put_EmitCompact(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 get_EmitCrLf(void);
void put_EmitCrLf(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 get_I(void);
void put_I(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 get_J(void);
void put_J(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 get_K(void);
void put_K(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 get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

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 get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

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 get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

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 get_LastMethodSuccess(void);
void put_LastMethodSuccess(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 get_LowerCaseNames(void);
void put_LowerCaseNames(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 get_PathPrefix(CkString &str);
const wchar_t *pathPrefix(void);
void put_PathPrefix(const wchar_t *str);

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 get_Size(void);

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 get_UncommonOptions(CkString &str);
const wchar_t *uncommonOptions(void);
void put_UncommonOptions(const wchar_t *str);

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.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(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 get_Version(CkString &str);
const wchar_t *version(void);

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 AddArrayAt(int index, const wchar_t *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 AddArrayCopyAt(int index, const wchar_t *name, CkJsonArrayW &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 AddBoolAt(int index, const wchar_t *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 AddIntAt(int index, const wchar_t *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 AddNullAt(int index, const wchar_t *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 AddNumberAt(int index, const wchar_t *name, 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

AddObjectAt

bool AddObjectAt(int index, const wchar_t *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 AddObjectCopyAt(int index, const wchar_t *name, CkJsonObjectW &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 AddStringAt(int index, const wchar_t *name, const wchar_t *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

CkJsonArrayW *AppendArray(const wchar_t *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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

JSON AppendArray Example

AppendArrayCopy

bool AppendArrayCopy(const wchar_t *name, CkJsonArrayW &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 AppendBool(const wchar_t *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 AppendInt(const wchar_t *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

CkJsonObjectW *AppendObject(const wchar_t *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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

JSON AppendObject Example

AppendObjectCopy

bool AppendObjectCopy(const wchar_t *name, CkJsonObjectW &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 AppendString(const wchar_t *name, const wchar_t *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 AppendStringArray(const wchar_t *name, CkStringTableW &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

CkJsonArrayW *ArrayAt(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).

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

Create more Complex JSON Document

ArrayOf

CkJsonArrayW *ArrayOf(const wchar_t *jsonPath);

Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

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

BoolAt

bool BoolAt(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 BoolOf(const wchar_t *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 BytesOf(const wchar_t *jsonPath, const wchar_t *encoding, CkBinDataW &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 Clear(void);

Introduced in version 9.5.0.76

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

Clone

CkJsonObjectW *Clone(void);

Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

DateOf

bool DateOf(const wchar_t *jsonPath, CkDateTimeW &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 Delete(const wchar_t *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 DeleteAt(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 DeleteRecords(const wchar_t *arrayPath, const wchar_t *relpath, const wchar_t *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 DtOf(const wchar_t *jsonPath, bool bLocal, CkDtObjW &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 Emit(CkString &outStr);
const wchar_t *emit(void);

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 EmitBd(CkBinDataW &bd);

Introduced in version 9.5.0.77

Emits (appends) to the contents of bd.

Returns true for success, false for failure.

EmitSb

bool EmitSb(CkStringBuilderW &sb);

Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns true for success, false for failure.

EmitWithSubs

bool EmitWithSubs(CkHashtableW &subs, bool omitEmpty, CkString &outStr);
const wchar_t *emitWithSubs(CkHashtableW &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

CkJsonObjectW *FindObjectWithMember(const wchar_t *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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

FindRecord

CkJsonObjectW *FindRecord(const wchar_t *arrayPath, const wchar_t *relPath, const wchar_t *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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

JSON FindRecord Example

FindRecordString

bool FindRecordString(const wchar_t *arrayPath, const wchar_t *relPath, const wchar_t *value, bool caseSensitive, const wchar_t *retRelPath, CkString &outStr);
const wchar_t *findRecordString(const wchar_t *arrayPath, const wchar_t *relPath, const wchar_t *value, bool caseSensitive, const wchar_t *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 FirebaseApplyEvent(const wchar_t *name, const wchar_t *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 FirebasePatch(const wchar_t *jsonPath, const wchar_t *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 FirebasePut(const wchar_t *jsonPath, const wchar_t *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

CkJsonObjectW *GetDocRoot(void);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

Get the Root of a JSON Document

HasMember

bool HasMember(const wchar_t *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 IndexOf(const wchar_t *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 IntAt(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 IntOf(const wchar_t *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 IsNullAt(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 IsNullOf(const wchar_t *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 JsonTypeOf(const wchar_t *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 Load(const wchar_t *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 LoadBd(CkBinDataW &bd);

Introduced in version 9.5.0.77

Loads the contents of bd.

Returns true for success, false for failure.

LoadFile

bool LoadFile(const wchar_t *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 LoadPredefined(const wchar_t *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 LoadSb(CkStringBuilderW &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 MoveMember(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 NameAt(int index, CkString &outStr);
const wchar_t *nameAt(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

CkJsonObjectW *ObjectAt(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).

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

Create more Complex JSON Document

ObjectOf

CkJsonObjectW *ObjectOf(const wchar_t *jsonPath);

Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples

JSON: Nested Objects JSON Paths

Predefine

bool Predefine(const wchar_t *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 Rename(const wchar_t *oldName, const wchar_t *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 RenameAt(int index, const wchar_t *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 SetBoolAt(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 SetBoolOf(const wchar_t *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 SetIntAt(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 SetIntOf(const wchar_t *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 SetNullAt(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 SetNullOf(const wchar_t *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 SetNumberAt(int index, const wchar_t *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 SetNumberOf(const wchar_t *jsonPath, const wchar_t *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 SetStringAt(int index, const wchar_t *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 SetStringOf(const wchar_t *jsonPath, const wchar_t *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 SizeOfArray(const wchar_t *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 Sort(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 StringAt(int index, CkString &outStr);
const wchar_t *stringAt(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 StringOf(const wchar_t *jsonPath, CkString &outStr);
const wchar_t *stringOf(const wchar_t *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 StringOfEquals(const wchar_t *jsonPath, const wchar_t *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 StringOfSb(const wchar_t *jsonPath, CkStringBuilderW &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 Swap(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 TypeAt(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 UIntOf(const wchar_t *jsonPath);

Introduced in version 9.5.0.96

Returns the unsigned integer at the specified jsonPath.

UpdateBd

bool UpdateBd(const wchar_t *jsonPath, const wchar_t *encoding, CkBinDataW &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 UpdateBool(const wchar_t *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 UpdateInt(const wchar_t *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 UpdateNewArray(const wchar_t *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 UpdateNewObject(const wchar_t *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 UpdateNull(const wchar_t *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 UpdateNumber(const wchar_t *jsonPath, const wchar_t *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 UpdateSb(const wchar_t *jsonPath, CkStringBuilderW &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 UpdateString(const wchar_t *jsonPath, const wchar_t *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 UpdateUInt(const wchar_t *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 WriteFile(const wchar_t *path);

Introduced in version 9.5.0.76

Saves the JSON to a file.

Returns true for success, false for failure.