JsonObject C Reference Documentation
JsonObject
Current Version: 11.5.0
Chilkat.JsonObject
Load JSON from strings, files, buffers, or Chilkat objects, then emit the
result as compact or pretty-formatted JSON.
Read and update nested values using JSON paths, with support for
automatically creating missing object or array paths.
Access object members by name or index, inspect member types, retrieve
values, and remove or rename members as needed.
Work directly with child
Search records, sort object members, perform Firebase-style updates, and
prepare JSON for API requests or application storage.
Handle date/time values, binary data encodings, exact numeric text,
variable substitution, and secure secret resolution.
For an extended overview, see
JsonObject Class Overview.
Load, navigate, create, modify, search, sort, and emit JSON objects.
Chilkat.JsonObject provides DOM-style access to JSON objects.
It can load, inspect, modify, create, search, sort, emit, and save JSON data.
It supports path-based access, index-based member access, automatic creation
of nested paths, object and array references, Firebase-style updates, record
searches, date/time conversion, binary data encoding, variable substitution,
and optional secure secret resolution.
Load and emit JSON
Path-based navigation
Member access
Nested objects and arrays
JsonObject and
JsonArray references to navigate and modify complex JSON
structures.
Search and transform
Special value handling
JsonObject, navigate named members and nested
paths, retrieve child arrays as JsonArray objects when ordered
lists are encountered, update values as needed, then emit or save the final
JSON. Use JsonObject for named JSON members and
JsonArray for ordered lists.
Create/Dispose
HCkJsonObject instance = CkJsonObject_Create(); // ... CkJsonObject_Dispose(instance);
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.
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_putDebugLogFilePath(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_debugLogFilePath(HCkJsonObject cHandle);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
DelimiterChar
void CkJsonObject_putDelimiterChar(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_delimiterChar(HCkJsonObject cHandle);
Specifies the character used to separate object-member names in Chilkat JSON paths. The default is .. Set it to / for Firebase-style paths. This property should contain exactly one character.
orders[0].id. If a member name itself contains a path-separator character, quote that path component with double quotes.EmitCompact
void CkJsonObject_putEmitCompact(HCkJsonObject cHandle, BOOL newVal);
Controls whether emitted JSON is compact or pretty-printed. The default is TRUE.
| Emit a compact representation with no extra formatting whitespace. |
| Emit indented, human-readable JSON. |
EmitCrLf
void CkJsonObject_putEmitCrLf(HCkJsonObject cHandle, BOOL newVal);
Controls line endings when pretty-printed JSON is emitted (EmitCompact = ). The default is FALSETRUE.
| Use CRLF line endings. |
| Use LF line endings. |
EmitCompact is TRUE because compact JSON is emitted without formatting line breaks.EnableSecrets
void CkJsonObject_putEnableSecrets(HCkJsonObject cHandle, BOOL newVal);
Enables automatic resolution of Chilkat secret specification strings for supported string-setting methods. The default is FALSE. When enabled, a value beginning with !! can identify a credential stored in Windows Credential Manager or Apple Keychain instead of embedding the literal secret in application code.
Secret specification format: !![appName|]service[|domain]|username.
This feature applies to AddStringAt, AppendString, SetStringAt, SetStringOf, UpdateSb, and UpdateString.
I
void CkJsonObject_putI(HCkJsonObject cHandle, int newVal);
Supplies the integer substituted for i when a JSON path contains an array index such as [i]. This is useful for loop-based navigation without constructing a new path string for every iteration.
J and K properties provide the same substitution behavior for [j] and [k].J
void CkJsonObject_putJ(HCkJsonObject cHandle, int newVal);
Supplies the integer substituted for j when a JSON path contains [j]. It is commonly used with nested-array paths such as matrix[i][j].
K
void CkJsonObject_putK(HCkJsonObject cHandle, int newVal);
Supplies the integer substituted for k when a JSON path contains [k]. It can be combined with I and J for deeper nested-array traversal.
LastErrorHtml
const char *CkJsonObject_lastErrorHtml(HCkJsonObject cHandle);
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
const char *CkJsonObject_lastErrorText(HCkJsonObject cHandle);
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
const char *CkJsonObject_lastErrorXml(HCkJsonObject cHandle);
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void CkJsonObject_putLastMethodSuccess(HCkJsonObject cHandle, BOOL newVal);
Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
LowerCaseNames
void CkJsonObject_putLowerCaseNames(HCkJsonObject cHandle, BOOL newVal);
If TRUE, member names are converted to lowercase while JSON is loaded by Load, LoadBd, LoadSb, or LoadFile. The default is FALSE.
PathPrefix
void CkJsonObject_putPathPrefix(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_pathPrefix(HCkJsonObject cHandle);
Specifies a path prefix automatically prepended to JSON paths passed to path-based methods such as StringOf, ObjectOf, UpdateString, SetBoolOf, and SizeOfArray. The default is the empty string.
Size
Returns the number of direct name/value members in this JSON object. Nested members inside child objects are not included.
UncommonOptions
void CkJsonObject_putUncommonOptions(HCkJsonObject cHandle, const char *newVal);
const char *CkJsonObject_uncommonOptions(HCkJsonObject cHandle);
Provides a catch-all string for uncommon, implementation-specific options. The default is the empty string and it should normally remain empty.
JsonObject option is documented by Chilkat or provided by Chilkat support.Utf8
void CkJsonObject_putUtf8(HCkJsonObject cHandle, BOOL newVal);
When set to TRUE, all const char * arguments and return values are interpreted as UTF-8 strings. When set to FALSE, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is TRUE. Before v11.0.0, it was FALSE.
VerboseLogging
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
const char *CkJsonObject_version(HCkJsonObject cHandle);
Methods
AddArrayAt
Inserts a new JSON array member named name at the zero-based member position index. The new array is empty.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AddArrayCopyAt
Inserts a new JSON array member named name at the zero-based member position index. The array value is copied from jarr; subsequent changes to the source array do not modify the inserted copy.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AddBoolAt
Inserts a new JSON boolean member named name at the zero-based member position index. The value is taken from value.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AddIntAt
Inserts a new JSON number member named name at the zero-based member position index. The integer value is emitted as a JSON number, not as a quoted string.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AddNullAt
Inserts a new JSON null member named name at the zero-based member position index.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AddNumberAt
Inserts a new JSON number member named name at the zero-based member position index. The numericStr argument supplies the exact JSON numeric text to store.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.12345678901234567890, 1.2500, or scientific notation. The supplied text must be valid JSON number syntax; JSON does not permit NaN or infinity.Returns TRUE for success, FALSE for failure.
AddObjectAt
Inserts a new JSON object member named name at the zero-based member position index. The new object is empty.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AddObjectCopyAt
Inserts a new JSON object member named name at the zero-based member position index. The object value is copied from jsonObj; the inserted value is independent of the source.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AddStringAt
Inserts a new JSON string member named name at the zero-based member position index. The value is stored as a JSON string and is escaped as needed when emitted.
0 | Insert as the first member. |
-1 | Append as the last member. |
n | Insert at zero-based position n. |
name is a direct member name, not a JSON path. Use an Update* or Set*Of method when addressing a nested value by path.Returns TRUE for success, FALSE for failure.
AppendArray
Appends a new JSON array member named name to this object. The newly appended array is empty and the returned JsonArray references that array in this document, so changes made through it modify the same JSON tree.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns NULL on failure
AppendArray2
Appends a new JSON array member named name to this object. A new empty array is created and jarr is updated to reference it. The method returns TRUE on success.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
topAppendArrayCopy
Appends a new JSON array member named name to this object. The array is copied from jarr, so the appended array is independent of the source array.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
AppendBool
Appends a new JSON boolean member named name to this object. The value is taken from value.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
topAppendInt
Appends a new JSON number member named name to this object. The integer value is stored as a JSON number.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
topAppendObject
Appends a new JSON object member named name to this object. The newly appended object is empty and the returned JsonObject references that object in this document.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns NULL on failure
AppendObject2
Appends a new JSON object member named name to this object. A new empty object is created and jsonObj is updated to reference it. The method returns TRUE on success.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
topAppendObjectCopy
Appends a new JSON object member named name to this object. The object is copied from jsonObj, so the appended object is independent of the source object.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
AppendString
Appends a new JSON string member named name to this object. The value is JSON-escaped as needed when emitted.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
topAppendStringArray
Appends a new JSON array member named name to this object. The array is populated with the strings contained in values.
name is a direct member name. It is not interpreted as a JSON path. Use the corresponding Update* method when a nested path should be addressed or created.Returns TRUE for success, FALSE for failure.
ArrayAt
Returns the JSON array stored in the member at zero-based position index. The returned JsonArray references the existing array in the same document; it is not a detached copy.
index must be an array. Use TypeAt when the member type is not already known.Returns NULL on failure
ArrayAt2
Updates jarr to reference the JSON array stored at zero-based member position index and returns TRUE on success.
Returns TRUE for success, FALSE for failure.
topArrayOf
Returns the JSON array at jsonPath. The returned JsonArray references the existing array in the same document, so modifications through it are reflected in the parent JSON.
orders[0].items.Returns NULL on failure
ArrayOf2
Updates jarr to reference the JSON array at jsonPath and returns TRUE on success.
Returns TRUE for success, FALSE for failure.
topBoolAt
Returns the boolean value of the member at zero-based position index.
JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.BoolOf
Returns the boolean value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.
BytesOf
Reads the string value at jsonPath, decodes it using encoding (for example, base64 or hex), and appends the resulting bytes to bd.
encoding argument tells Chilkat how that text represents the original bytes.Returns TRUE for success, FALSE for failure.
Clear
Removes all members from this JSON object, leaving an empty object equivalent to {}.
CopyRef
Updates jsonObj so that it references the same JSON object as the caller. No JSON data is copied.
Returns TRUE for success, FALSE for failure.
topDateOf
Parses the date/time value at jsonPath and loads the result into dateTime. Recognized forms include ISO 8601 timestamps (for example, 2009-11-04T19:55:41Z), RFC 822-style date/time strings, and Unix timestamp integers.
CkDateTime.Returns TRUE for success, FALSE for failure.
Delete
Deletes the direct member named name from this JSON object.
name is a member name, not a JSON path. Use a path-based operation when deleting or replacing a nested value requires navigation first.Returns TRUE for success, FALSE for failure.
DeleteAt
Deletes the member at zero-based position index. Members after the deleted position shift toward the beginning.
Returns TRUE for success, FALSE for failure.
DeleteRecords
Deletes every object record in the array at arrayPath whose value at relative path relpath equals or wildcard-matches value. The caseSensitive argument controls matching. Returns the number of records deleted.
DtOf
Parses the date/time value at jsonPath into dt. If bLocal is TRUE, the destination receives local date/time fields; otherwise it receives UTC/GMT fields. Recognized inputs include ISO 8601 timestamps, RFC 822-style date/time strings, and Unix timestamp integers.
Returns TRUE for success, FALSE for failure.
Emit
const char *CkJsonObject_emit(HCkJsonObject cHandle);
Serializes the JSON document rooted at this object and returns the JSON text. Formatting is controlled by EmitCompact and, for pretty output, EmitCrLf.
Returns TRUE for success, FALSE for failure.
EmitBd
Serializes this JSON and appends the resulting bytes to bd.
BinData is preserved.Returns TRUE for success, FALSE for failure.
topEmitSb
Serializes this JSON and appends the resulting text to sb. Formatting follows EmitCompact and EmitCrLf.
StringBuilder is preserved; the emitted JSON is added after it.Returns TRUE for success, FALSE for failure.
topEmitWithSubs
const char *CkJsonObject_emitWithSubs(HCkJsonObject cHandle, HCkHashtable subs, BOOL omitEmpty);
Serializes the JSON after substituting variables from subs into template strings. A placeholder such as {$name} is replaced by the corresponding hashtable value. Prefixing the variable name with i., as in {$i.count}, emits the substituted value as a JSON integer instead of a quoted string.
If omitEmpty is TRUE, members whose substituted result is an empty string or empty array are omitted from the emitted JSON.
Predefine and LoadPredefined when the same JSON shape is emitted repeatedly with different values.Returns TRUE for success, FALSE for failure.
FindObjectWithMember
Recursively searches this JSON subtree for the first JSON object containing a direct member named name. Returns that object, or NULL if no matching object is found.
Returns NULL on failure
FindObjectWithMember2
Recursively searches this JSON subtree for the first object containing a direct member named name. On success, jsonObj is updated to reference the matching object and the method returns TRUE.
Returns TRUE for success, FALSE for failure.
topFindRecord
Searches the JSON array at arrayPath for the first object whose value at relative path relPath equals or wildcard-matches value. The caseSensitive argument controls string comparison. Returns the matching record object.
* to match zero or more characters. relPath is evaluated relative to each record object in the array.Returns NULL on failure
FindRecord2
Searches the JSON array at arrayPath using the same matching rules as FindRecord. On success, jsonObj is updated to reference the first matching record and the method returns TRUE.
jsonObj modify that record.Returns TRUE for success, FALSE for failure.
topFindRecordString
const char *CkJsonObject_findRecordString(HCkJsonObject cHandle, const char *arrayPath, const char *relPath, const char *value, BOOL caseSensitive, const char *retRelPath);
Searches the JSON array at arrayPath for the first record whose relPath value equals or wildcard-matches value, then returns the value at retRelPath from that same record as a string.
Name is Advertising and return its Id.” The * wildcard may be used in value.Returns TRUE for success, FALSE for failure.
FirebaseApplyEvent
Applies a Firebase Realtime Database event to this JSON object. name should be put or patch, and data should contain event JSON such as {"path":"/","data":{"a":1,"b":2}}.
put replaces the value at a path, while patch updates individual child keys.Returns TRUE for success, FALSE for failure.
FirebasePatch
Applies Firebase-style patch semantics at jsonPath. jsonData must contain a JSON object; each key in that object updates or adds the corresponding key at the target path.
jsonPath is relative to this JsonObject.Returns TRUE for success, FALSE for failure.
FirebasePut
Applies Firebase-style put semantics at jsonPath, replacing or inserting the value at that path. value is JSON text and may represent an object, array, number, boolean, null, or a quoted JSON string.
value must contain a valid JSON string literal, including its surrounding double quotes. Use UpdateString when you already have an ordinary application string.Returns TRUE for success, FALSE for failure.
GetDocRoot
Returns a JsonObject reference to the root object of the JSON document containing this object. This can be called from any nested object reference.
JsonObject references share the same underlying JSON document. The document remains available while at least one such reference is retained by the application.Returns NULL on failure
GetDocRoot2
Updates docRoot to reference the root object of the JSON document containing the caller and returns TRUE on success.
Returns TRUE for success, FALSE for failure.
topHasMember
Returns TRUE if a value exists at jsonPath; otherwise returns FALSE.
null still exists. Use IsNullOf to test specifically for JSON null.Returns TRUE for success, FALSE for failure.
topIndexOf
Returns the zero-based position of the direct member named name, or -1 if that member name is not found.
name is searched only among the direct members of this object.IntAt
Returns the integer value of the member at zero-based position index.
JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.IntOf
Returns the integer value at jsonPath. The path is evaluated relative to this JsonObject, after applying PathPrefix if one is set.
StringOf or the exact numeric-text APIs when a JSON integer may exceed the range of the language binding's integer type.IsNullAt
Returns TRUE if the member at zero-based position index has the JSON value null; otherwise returns FALSE.
IsNullOf
Returns TRUE if the value at jsonPath is the JSON literal null; otherwise returns FALSE.
null is different from a missing member and from an empty string. Use HasMember when existence must be tested separately.JsonTypeOf
Returns an integer identifying the JSON type of the value at jsonPath. Returns -1 if no member exists at that path.
1 | string |
2 | number |
3 | object |
4 | array |
5 | boolean |
6 | null |
Load
Parses the JSON text in json and loads the parsed data into this object for DOM-style access and modification.
null, objects, or arrays. Object member names should be unique for interoperable JSON; RFC 8259 notes that consumers differ in how duplicate names are handled.Returns TRUE for success, FALSE for failure.
LoadBd
Parses JSON from the bytes contained in bd and loads it into this object.
Returns TRUE for success, FALSE for failure.
topLoadFile
Reads JSON text from the file at path, parses it, and loads the result into this object.
Returns TRUE for success, FALSE for failure.
LoadPredefined
Loads this object from the predefined JSON document identified by name. Predefined documents are created with Predefine.
Returns TRUE for success, FALSE for failure.
LoadSb
Parses JSON from the current contents of sb and loads it into this object.
Returns TRUE for success, FALSE for failure.
MakeCopy
Copies this JSON object into json. The destination receives an independent JSON copy rather than another reference to the same underlying object.
CopyRef when two JsonObject instances should refer to the same JSON object instead of duplicating its data.Returns TRUE for success, FALSE for failure.
topMoveMember
Moves the direct member at zero-based position fromIndex to toIndex. Use toIndex = 0 to move it first or -1 to move it last.
Returns TRUE for success, FALSE for failure.
topNameAt
const char *CkJsonObject_nameAt(HCkJsonObject cHandle, int index);
Returns the name of the member at zero-based position index. Use this with Size and TypeAt to iterate through an object's direct members.
Returns TRUE for success, FALSE for failure.
NewArrayOf
Creates a JSON array at path and loads that array from the JSON text in jArr. The supplied text should represent a JSON array.
UpdateNewArray creates an empty array. NewArrayOf creates the array and immediately populates it from JSON text.Returns TRUE for success, FALSE for failure.
NewObjectOf
Creates a JSON object at path and loads that object from the JSON text in jObj. The supplied text should represent a JSON object.
UpdateNewObject creates an empty object. NewObjectOf creates the object and immediately populates it from JSON text.Returns TRUE for success, FALSE for failure.
ObjectAt
Returns the JSON object stored in the member at zero-based position index. The returned JsonObject references the existing child object in the same document; changes made through it modify that document.
index must be a JSON object. Use TypeAt when the type is not already known.Returns NULL on failure
ObjectAt2
Updates jsonObj to reference the JSON object stored at zero-based member position index and returns TRUE on success.
Returns TRUE for success, FALSE for failure.
topObjectOf
Returns the JSON object at jsonPath. The returned object is a live reference into the same JSON document, not a copy.
GetDocRoot when access must start from the document root.Returns NULL on failure
ObjectOf2
Updates jsonObj to reference the JSON object at jsonPath and returns TRUE on success.
Returns TRUE for success, FALSE for failure.
topPredefine
Stores this JSON document in Chilkat's internal global collection of predefined JSON documents under name. If the name already exists, the predefined value is replaced.
JsonObject can load it by name with LoadPredefined.Returns TRUE for success, FALSE for failure.
Rename
Renames the direct member oldName to newName. The member value and its position are otherwise unchanged.
Returns TRUE for success, FALSE for failure.
RenameAt
Renames the member at zero-based position index to name. The member value is not changed.
Returns TRUE for success, FALSE for failure.
SetBoolAt
Sets the member at zero-based position index to a JSON boolean value.
Returns TRUE for success, FALSE for failure.
SetBoolOf
Sets the value at jsonPath to a JSON boolean value.
UpdateBool when missing objects or array positions along the path should be created automatically.Returns TRUE for success, FALSE for failure.
SetIntAt
Sets the member at zero-based position index to a JSON number value. The integer is emitted as a JSON number.
Returns TRUE for success, FALSE for failure.
SetIntOf
Sets the value at jsonPath to an integer JSON number.
UpdateInt when missing objects or array positions along the path should be created automatically.Returns TRUE for success, FALSE for failure.
SetNullAt
Sets the member at zero-based position index to a JSON null value.
Returns TRUE for success, FALSE for failure.
SetNullOf
Sets the value at jsonPath to a JSON null value.
UpdateNull when missing objects or array positions along the path should be created automatically.Returns TRUE for success, FALSE for failure.
SetNumberAt
Sets the member at zero-based position index to a JSON number value. The value argument is the exact textual representation of the JSON number.
NaN, and infinity are not valid JSON numbers.Returns TRUE for success, FALSE for failure.
SetNumberOf
Sets the value at jsonPath to a JSON number value. The value argument supplies the exact textual form of the JSON number.
UpdateNumber when missing objects or array positions along the path should be created automatically.Returns TRUE for success, FALSE for failure.
SetStringAt
Sets the member at zero-based position index to a JSON string value. The string is escaped as required when JSON is emitted.
Returns TRUE for success, FALSE for failure.
SetStringOf
Sets the value at jsonPath to a JSON string value. The string is escaped as required when JSON is emitted.
UpdateString when missing objects or array positions along the path should be created automatically.Returns TRUE for success, FALSE for failure.
SizeOfArray
Returns the number of elements in the JSON array at jsonPath. Returns -1 if the path does not resolve to an existing JSON array.
Sort
Sorts this object's direct members by member name. ascending selects ascending or descending order, and caseSensitive controls how names are compared.
StringAt
const char *CkJsonObject_stringAt(HCkJsonObject cHandle, int index);
Returns the string value of the member at zero-based position index.
JsonObject instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.StringOf can also provide textual representations of scalar JSON values such as numbers, booleans, and null; use the type-specific methods when the JSON type itself matters.Returns TRUE for success, FALSE for failure.
StringOf
const char *CkJsonObject_stringOf(HCkJsonObject cHandle, const char *jsonPath);
Returns the value at jsonPath as text. For a JSON string, the string value is returned. Scalar non-string values such as numbers, booleans, and null are returned using their JSON textual representation.
JsonTypeOf, IntOf, BoolOf, or IsNullOf when the distinction between JSON types is important.Returns TRUE for success, FALSE for failure.
StringOfEquals
Returns TRUE if the textual value at jsonPath equals value according to the caseSensitive setting; otherwise returns FALSE.
StringOfSb
Retrieves the value at jsonPath as text and appends it to sb.
StringBuilder are preserved.Returns TRUE for success, FALSE for failure.
topSwap
Swaps the positions of the direct members at zero-based indexes index1 and index2. Member names and values are unchanged.
Returns TRUE for success, FALSE for failure.
TypeAt
Returns an integer identifying the JSON type of the member at zero-based position index. Returns -1 if no member exists at that index.
1 | string |
2 | number |
3 | object |
4 | array |
5 | boolean |
6 | null |
UIntOf
Returns the unsigned integer value at jsonPath.
UpdateBd
Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The bytes in bd are first encoded according to encoding (for example, base64 or hex) and the encoded text is stored as the JSON string value.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns TRUE for success, FALSE for failure.
UpdateBool
Updates the value at jsonPath to a JSON boolean value, or creates the member and any missing path components as needed.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns TRUE for success, FALSE for failure.
topUpdateInt
Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The integer value is stored as a JSON number.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns TRUE for success, FALSE for failure.
UpdateNewArray
Creates or replaces the value at jsonPath with a new empty JSON array. Missing path components are created automatically as needed.
Returns TRUE for success, FALSE for failure.
UpdateNewObject
Creates or replaces the value at jsonPath with a new empty JSON object. Missing path components are created automatically as needed.
Returns TRUE for success, FALSE for failure.
UpdateNull
Updates the value at jsonPath to a JSON null value, or creates the member and any missing path components as needed.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns TRUE for success, FALSE for failure.
topUpdateNumber
Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The numericStr argument is stored as the exact textual representation of the JSON number.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.UpdateNumber instead of UpdateInt for decimal/exponent forms, very large integers, or when preserving exact numeric text is important.Returns TRUE for success, FALSE for failure.
UpdateSb
Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The new string value is taken from the contents of sb.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns TRUE for success, FALSE for failure.
topUpdateString
Updates the value at jsonPath to a JSON string value, or creates the member and any missing path components as needed. The supplied string is JSON-escaped as needed.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns TRUE for success, FALSE for failure.
UpdateUInt
Updates the value at jsonPath to a JSON number value, or creates the member and any missing path components as needed. The unsigned integer is stored as a JSON number.
jsonPath is interpreted using DelimiterChar, PathPrefix, and the I/J/K index substitutions.Returns TRUE for success, FALSE for failure.
topWriteFile
Serializes this JSON and writes it to the file at path. Output formatting follows EmitCompact and EmitCrLf.
Returns TRUE for success, FALSE for failure.
topDeprecated
Clone
Deprecated. Use MakeCopy instead. Returns an independent copy of this JSON object.
Returns NULL on failure