JsonObject PureBasic Reference Documentation

JsonObject

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

obj.i = CkJsonObject::ckCreate()

; Make sure to dispose of the object when finished like this:
CkJsonObject::ckDispose(obj);

Properties

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

Declare.s ckDelimiterChar(obj.i)
Declare setCkDelimiterChar(obj.i, value.s)

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

Declare.i ckEmitCompact(obj.i)
Declare setCkEmitCompact(obj.i, value.i)

Introduced in version 9.5.0.56

If 1 then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If 0, then emits with whitespace and indentation to make the JSON human-readable.

The default value is 1.

Declare.i ckEmitCrLf(obj.i)
Declare setCkEmitCrLf(obj.i, value.i)

Introduced in version 9.5.0.56

If 1 then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If 0, 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 1.

Declare.i ckI(obj.i)
Declare setCkI(obj.i, value.i)

Introduced in version 9.5.0.56

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

JSON Paths

Declare.i ckJ(obj.i)
Declare setCkJ(obj.i, value.i)

Introduced in version 9.5.0.56

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

Declare.i ckK(obj.i)
Declare setCkK(obj.i, value.i)

Introduced in version 9.5.0.56

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

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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.

Declare.s ckLastErrorText(obj.i) ; (read-only)

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.

Concept of LastErrorText

LastErrorText Standard Information

Declare.s ckLastErrorXml(obj.i) ; (read-only)

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.

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

Declare.i ckSize(obj.i) ; (read-only)

Introduced in version 9.5.0.56

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

JSON Iterate Members

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Declare.s ckVersion(obj.i) ; (read-only)

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

Methods

Declare.i ckAddArrayAt(obj.i, index.l, name.s)

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 1 for success, 0 for failure.

Create more Complex JSON Document

Declare.i ckAddBoolAt(obj.i, index.l, name.s, value.l)

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 1 for success, 0 for failure.

JSON: Miscellaneous Operations

Declare.i ckAddIntAt(obj.i, index.l, name.s, value.l)

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 1 for success, 0 for failure.

Create JSON Document

Declare.i ckAddNullAt(obj.i, index.l, name.s)

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 1 for success, 0 for failure.

JSON: Miscellaneous Operations

Declare.i ckAddNumberAt(obj.i, index.l, name.s, numericStr.s)

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 1 for success, 0 for failure.

Create more Complex JSON Document

Declare.i ckAddObjectAt(obj.i, index.l, name.s)

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 1 for success, 0 for failure.

Create more Complex JSON Document

Declare.i ckAddStringAt(obj.i, index.l, name.s, value.s)

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 1 for success, 0 for failure.

Create JSON Document

Declare.i ckAppendArray(obj.i, name.s)

Introduced in version 9.5.0.58

Appends a new and empty JSON array and returns it.

Returns 0 on failure

Declare.i ckAppendBool(obj.i, name.s, value.l)

Introduced in version 9.5.0.58

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

Returns 1 for success, 0 for failure.

Declare.i ckAppendInt(obj.i, name.s, value.l)

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

Returns 1 for success, 0 for failure.

Declare.i ckAppendObject(obj.i, name.s)

Introduced in version 9.5.0.58

Appends a new and empty JSON object and returns it.

Returns 0 on failure

Declare.i ckAppendString(obj.i, name.s, value.s)

Introduced in version 9.5.0.58

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

Returns 1 for success, 0 for failure.

Declare.i ckAppendStringArray(obj.i, name.s, values.i)

Introduced in version 9.5.0.67

Appends an array of string values.

Returns 1 for success, 0 for failure.

JSON Append String Array

Declare.i ckArrayAt(obj.i, index.l)

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 0 on failure

Create more Complex JSON Document

Declare.i ckArrayOf(obj.i, jsonPath.s)

Introduced in version 9.5.0.56

Returns the JSON array at the specified jsonPath.

Returns 0 on failure

JSON: Access Array Values

Modify Parts of JSON Document

JSON Paths

Declare.i ckBoolAt(obj.i, index.l)

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

JSON: Miscellaneous Operations

Declare.i ckBoolOf(obj.i, jsonPath.s)

Introduced in version 9.5.0.56

Returns the boolean at the specified jsonPath.

JSON: Miscellaneous Operations

JSON Paths

Declare.i ckBytesOf(obj.i, jsonPath.s, encoding.s, bd.i)

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 1 for success, 0 for failure.

Declare.i ckClone(obj.i)

Introduced in version 9.5.0.66

Returns a copy of this JSON object.

Returns 0 on failure

Declare.i ckDelete(obj.i, name.s)

Introduced in version 9.5.0.56

Deletes the member at having the name specified by name.

Returns 1 for success, 0 for failure.

JSON: Renaming and Deleting Members

Declare.i ckDeleteAt(obj.i, index.l)

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 1 for success, 0 for failure.

JSON: Renaming and Deleting Members

Declare.s ckEmit(obj.i)

Introduced in version 9.5.0.56

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Pretty Print JSON (Formatter, Beautifier)

Declare.i ckEmitSb(obj.i, sb.i)

Introduced in version 9.5.0.62

Appends the JSON to a StringBuilder object.

Returns 1 for success, 0 for failure.

Declare.s ckEmitWithSubs(obj.i, subs.i, omitEmpty.l)

Introduced in version 9.5.0.67

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Using Pre-defined JSON Templates

Declare.i ckFindObjectWithMember(obj.i, name.s)

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 0 if not found.

Returns 0 on failure

Declare.i ckFindRecord(obj.i, arrayPath.s, relPath.s, value.s, caseSensitive.l)

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 0 on failure

JSON FindRecord Example

Declare.s ckFindRecordString(obj.i, arrayPath.s, relPath.s, value.s, caseSensitive.l, retRelPath.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

JSON FindRecordString Example

Declare.i ckFirebaseApplyEvent(obj.i, name.s, argData.s)

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 1 for success, 0 for failure.

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

Declare.i ckFirebasePatch(obj.i, jsonPath.s, jsonData.s)

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 1 for success, 0 for failure.

Firebase JSON Put and Patch

Declare.i ckFirebasePut(obj.i, jsonPath.s, value.s)

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 1 for success, 0 for failure.

Firebase JSON Put and Patch

Declare.i ckGetDocRoot(obj.i)

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 0 on failure

Get the Root of a JSON Document

Declare.i ckHasMember(obj.i, jsonPath.s)

Introduced in version 9.5.0.58

Returns 1 if the item at the jsonPath exists.

Returns 1 for success, 0 for failure.

Declare.i ckIndexOf(obj.i, name.s)

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.

Get the Index of a JSON Member

Declare.i ckIntAt(obj.i, index.l)

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

JSON Iterate Members

Declare.i ckIntOf(obj.i, jsonPath.s)

Introduced in version 9.5.0.56

Returns the integer at the specified jsonPath.

JSON: Miscellaneous Operations

JSON Paths

Declare.i ckIsNullAt(obj.i, index.l)

Introduced in version 9.5.0.56

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

JSON: Miscellaneous Operations

Declare.i ckIsNullOf(obj.i, jsonPath.s)

Introduced in version 9.5.0.56

Returns 1 if the value at the specified jsonPath is null. Otherwise returns 0.

JSON: Miscellaneous Operations

JSON Paths

Declare.i ckLoad(obj.i, json.s)

Introduced in version 9.5.0.56

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

Returns 1 for success, 0 for failure.

Load JSON Data at Path

Load a JSON Array

Loading and Parsing a JSON Array

Declare.i ckLoadFile(obj.i, path.s)

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 1 for success, 0 for failure.

Load a JSON Array

Declare.i ckLoadPredefined(obj.i, name.s)

Introduced in version 9.5.0.67

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

Returns 1 for success, 0 for failure.

Using Pre-defined JSON Templates

Declare.i ckLoadSb(obj.i, sb.i)

Introduced in version 9.5.0.62

Loads JSON from the contents of a StringBuilder object.

Returns 1 for success, 0 for failure.

Declare.s ckNameAt(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

JSON Iterate Members

Declare.i ckObjectAt(obj.i, index.l)

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 0 on failure

Create more Complex JSON Document

Declare.i ckObjectOf(obj.i, jsonPath.s)

Introduced in version 9.5.0.56

Returns the JSON object at the specified jsonPath.

Returns 0 on failure

JSON: Nested Objects

JSON Paths

Declare.i ckPredefine(obj.i, name.s)

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 1 for success, 0 for failure.

Using Pre-defined JSON Templates

Declare.i ckRename(obj.i, oldName.s, newName.s)

Introduced in version 9.5.0.56

Renames the member named oldName to newName.

Returns 1 for success, 0 for failure.

JSON: Renaming and Deleting Members

Declare.i ckRenameAt(obj.i, index.l, name.s)

Introduced in version 9.5.0.56

Renames the member at index to name.

Returns 1 for success, 0 for failure.

JSON: Renaming and Deleting Members

Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.

Declare.i ckSetBoolAt(obj.i, index.l, value.l)

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 1 for success, 0 for failure.

Modify Parts of JSON Document

Declare.i ckSetBoolOf(obj.i, jsonPath.s, value.l)

Introduced in version 9.5.0.56

Sets the boolean value at the specified jsonPath.

Returns 1 for success, 0 for failure.

Modify Parts of JSON Document

JSON Paths

Declare.i ckSetIntAt(obj.i, index.l, value.l)

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 1 for success, 0 for failure.

Modify Parts of JSON Document

Declare.i ckSetIntOf(obj.i, jsonPath.s, value.l)

Introduced in version 9.5.0.56

Sets the integer at the specified jsonPath.

Returns 1 for success, 0 for failure.

Modify Parts of JSON Document

JSON Paths

Declare.i ckSetNullAt(obj.i, index.l)

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 1 for success, 0 for failure.

JSON: Miscellaneous Operations

Declare.i ckSetNullOf(obj.i, jsonPath.s)

Introduced in version 9.5.0.56

Sets the value at the specified jsonPath to null.

Returns 1 for success, 0 for failure.

JSON: Miscellaneous Operations

JSON Paths

Declare.i ckSetNumberAt(obj.i, index.l, value.s)

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 1 for success, 0 for failure.

JSON: Miscellaneous Operations

Declare.i ckSetNumberOf(obj.i, jsonPath.s, value.s)

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 1 for success, 0 for failure.

JSON: Miscellaneous Operations

JSON Paths

Declare.i ckSetStringAt(obj.i, index.l, value.s)

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 1 for success, 0 for failure.

Modify Parts of JSON Document

Declare.i ckSetStringOf(obj.i, jsonPath.s, value.s)

Introduced in version 9.5.0.56

Sets the string value at the specified jsonPath.

Returns 1 for success, 0 for failure.

Modify Parts of JSON Document

JSON Paths

Declare.i ckSizeOfArray(obj.i, jsonPath.s)

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.

JSON Paths

Declare.s ckStringAt(obj.i, index.l)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

JSON Iterate Members

Declare.s ckStringOf(obj.i, jsonPath.s)

Introduced in version 9.5.0.56

Returns the string value at the specified jsonPath.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

JSON: Miscellaneous Operations

JSON Paths

JSON Paths that need Double Quotes

Declare.i ckStringOfSb(obj.i, jsonPath.s, sb.i)

Introduced in version 9.5.0.68

Appends the string value at the specified jsonPath to sb.

Returns 1 for success, 0 for failure.

Declare.i ckTypeAt(obj.i, index.l)

Introduced in version 9.5.0.58

Returns the type of data at the given index. Possible return values are:

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

Declare.i ckUpdateBd(obj.i, jsonPath.s, encoding.s, bd.i)

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 1 for success, 0 for failure.

Declare.i ckUpdateBool(obj.i, jsonPath.s, value.l)

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 1 for success, 0 for failure.

Declare.i ckUpdateInt(obj.i, jsonPath.s, value.l)

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 1 for success, 0 for failure.

Declare.i ckUpdateNull(obj.i, jsonPath.s)

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 1 for success, 0 for failure.

Declare.i ckUpdateNumber(obj.i, jsonPath.s, numericStr.s)

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 1 for success, 0 for failure.

Declare.i ckUpdateSb(obj.i, jsonPath.s, sb.i)

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 1 for success, 0 for failure.

Declare.i ckUpdateString(obj.i, jsonPath.s, value.s)

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 1 for success, 0 for failure.

JSON UpdateString