JsonObject PureBasic Reference Documentation
JsonObject
Current Version: 10.0.0
Represents a JSON object, which contains an unordered set of name/value pairs. Each value can be a string, number, JSON object, JSON array, true, false, or null.
Object Creation
obj.i = CkJsonObject::ckCreate()
; Make sure to dispose of the object when finished like this:
CkJsonObject::ckDispose(obj);
Properties
DebugLogFilePath
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:
- 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.
DelimiterChar
Declare setCkDelimiterChar(obj.i, value.s)
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.)
topEmitCompact
Declare setCkEmitCompact(obj.i, value.i)
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.
topEmitCrLf
Declare setCkEmitCrLf(obj.i, value.i)
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.
topI
Declare setCkI(obj.i, value.i)
The value of the "i" index to be used when evaluating a JSON path.
J
Declare setCkJ(obj.i, value.i)
The value of the "j" index to be used when evaluating a JSON path.
topK
Declare setCkK(obj.i, value.i)
The value of the "k" index to be used when evaluating a JSON path.
topLastErrorHtml
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
Declare setCkLastMethodSuccess(obj.i, value.i)
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.
topLowerCaseNames
Declare setCkLowerCaseNames(obj.i, value.i)
If 1 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 0.
topPathPrefix
Declare setCkPathPrefix(obj.i, value.s)
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.
topSize
UncommonOptions
Declare setCkUncommonOptions(obj.i, value.s)
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topVerboseLogging
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.
topVersion
Methods
AddArrayAt
Inserts a new and empty JSON array member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
AddArrayCopyAt
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 1 for success, 0 for failure.
AddBoolAt
Inserts a new boolean member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
AddIntAt
Inserts a new integer member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
AddNullAt
Inserts a new null member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
AddNumberAt
Inserts a new numeric member to the position indicated by index. The numericStr is an integer, float, or double already converted to a string in the format desired by the application. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
AddObjectAt
Inserts a new and empty JSON object member to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
AddObjectCopyAt
Inserts a copy of a JSON object to the position indicated by index. To prepend, pass an index of 0. To append, pass an index of -1. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
AddStringAt
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.
AppendArray
Appends a new and empty JSON array and returns it.
Important: The name is the member name, it is not a JSON path.
Returns 0 on failure
AppendArrayCopy
Appends a copy of a JSON array.
Important: The name is the member name, it is not a JSON path.
Returns 1 for success, 0 for failure.
AppendBool
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 1 for success, 0 for failure.
topAppendInt
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 1 for success, 0 for failure.
topAppendObject
Appends a new and empty JSON object and returns it.
Important: The name is the member name, it is not a JSON path.
Returns 0 on failure
AppendObjectCopy
Appends a copy of a JSON object.
Important: The name is the member name, it is not a JSON path.
Returns 1 for success, 0 for failure.
AppendString
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 1 for success, 0 for failure.
topAppendStringArray
Appends an array of string values.
Important: The name is the member name, it is not a JSON path.
Returns 1 for success, 0 for failure.
ArrayAt
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
ArrayOf
Returns the JSON array at the specified jsonPath.
Returns 0 on failure
BoolAt
Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
BoolOf
BytesOf
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.
Clear
Clears the contents of the JSON object. This is the equivalent of calling jsonObject.Load("{}")
topClone
DateOf
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 1 for success, 0 for failure.
Delete
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 1 for success, 0 for failure.
DeleteAt
Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
DeleteRecords
Deletes JSON records in an array where a particular field equals or matches a value pattern. Returns the number of JSON records deleted.
topDtOf
Fills the dt with the date/time string located at jsonPath. If bLocal is 1, 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 1 for success, 0 for failure.
Emit
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.
EmitBd
EmitSb
EmitWithSubs
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.
FindObjectWithMember
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
topFindRecord
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
FindRecordString
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.
FirebaseApplyEvent
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.
FirebasePatch
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.
FirebasePut
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.
GetDocRoot
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
HasMember
IndexOf
Returns the index of the member having the given name. Returns -1 if the name is not found.
IntAt
Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
IntOf
IsNullAt
Returns the boolean value of the member having the specified index.
IsNullOf
Returns 1 if the value at the specified jsonPath is null. Otherwise returns 0.
JsonTypeOf
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
Load
Parses a JSON string and loads it into this JSON object to provide DOM-style access.
Returns 1 for success, 0 for failure.
LoadBd
LoadFile
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.
LoadPredefined
Loads this JSON object from a predefined document having a specified name.
Returns 1 for success, 0 for failure.
LoadSb
Loads JSON from the contents of a StringBuilder object.
Returns 1 for success, 0 for failure.
MoveMember
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 1 for success, 0 for failure.
topNameAt
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.
ObjectAt
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
ObjectOf
Returns the JSON object at the specified jsonPath.
Returns 0 on failure
Predefine
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.
Rename
Renames the member named oldName to newName.
Returns 1 for success, 0 for failure.
RenameAt
Renames the member at index to name.
Returns 1 for success, 0 for failure.
SetBoolAt
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.
SetBoolOf
Sets the boolean value at the specified jsonPath.
Returns 1 for success, 0 for failure.
SetIntAt
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.
SetIntOf
Sets the integer at the specified jsonPath.
Returns 1 for success, 0 for failure.
SetNullAt
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.
SetNullOf
Sets the value at the specified jsonPath to null.
Returns 1 for success, 0 for failure.
SetNumberAt
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.
SetNumberOf
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.
SetStringAt
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.
SetStringOf
Sets the string value at the specified jsonPath.
Returns 1 for success, 0 for failure.
SizeOfArray
Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.
Sort
StringAt
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.
StringOf
Returns the string value at the specified jsonPath.
Returns an empty string on failure. Use the LastMethodSuccess property to check for success.
StringOfEquals
Returns 1 if the string value at the specified jsonPath equals value. Otherwise returns 0
topStringOfSb
Swap
Swaps the positions of members at index1 and index2.
Returns 1 for success, 0 for failure.
TypeAt
Returns the type of data at the given index. Possible return values are:
- string
- number
- object
- array
- boolean
- null
UIntOf
Returns the unsigned integer at the specified jsonPath.
topUpdateBd
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.
UpdateBool
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.
topUpdateInt
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.
UpdateNewArray
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 1 for success, 0 for failure.
UpdateNewObject
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 1 for success, 0 for failure.
UpdateNull
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.
topUpdateNumber
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.
UpdateSb
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.
topUpdateString
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.
UpdateUInt
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 1 for success, 0 for failure.
top