JsonObject Tcl 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
set myJsonObject [new CkJsonObject]
Properties
DebugLogFilePath
# ckStr is a CkString
CkJsonObject_get_DebugLogFilePath $myJsonObject $ckStr
set strVal [CkJsonObject_get_debugLogFilePath $myJsonObject]
CkJsonObject_put_DebugLogFilePath $myJsonObject $strVal
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
# ckStr is a CkString
CkJsonObject_get_DelimiterChar $myJsonObject $ckStr
set strVal [CkJsonObject_get_delimiterChar $myJsonObject]
CkJsonObject_put_DelimiterChar $myJsonObject $strVal
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
set boolVal [CkJsonObject_get_EmitCompact $myJsonObject]
CkJsonObject_put_EmitCompact $myJsonObject $boolVal
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
set boolVal [CkJsonObject_get_EmitCrLf $myJsonObject]
CkJsonObject_put_EmitCrLf $myJsonObject $boolVal
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
set intVal [CkJsonObject_get_I $myJsonObject]
CkJsonObject_put_I $myJsonObject $intVal
The value of the "i" index to be used when evaluating a JSON path.
J
set intVal [CkJsonObject_get_J $myJsonObject]
CkJsonObject_put_J $myJsonObject $intVal
The value of the "j" index to be used when evaluating a JSON path.
topK
set intVal [CkJsonObject_get_K $myJsonObject]
CkJsonObject_put_K $myJsonObject $intVal
The value of the "k" index to be used when evaluating a JSON path.
topLastErrorHtml
# ckStr is a CkString
CkJsonObject_get_LastErrorHtml $myJsonObject $ckStr
set strVal [CkJsonObject_get_lastErrorHtml $myJsonObject]
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
# ckStr is a CkString
CkJsonObject_get_LastErrorText $myJsonObject $ckStr
set strVal [CkJsonObject_get_lastErrorText $myJsonObject]
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
# ckStr is a CkString
CkJsonObject_get_LastErrorXml $myJsonObject $ckStr
set strVal [CkJsonObject_get_lastErrorXml $myJsonObject]
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
set boolVal [CkJsonObject_get_LastMethodSuccess $myJsonObject]
CkJsonObject_put_LastMethodSuccess $myJsonObject $boolVal
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
set boolVal [CkJsonObject_get_LowerCaseNames $myJsonObject]
CkJsonObject_put_LowerCaseNames $myJsonObject $boolVal
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
# ckStr is a CkString
CkJsonObject_get_PathPrefix $myJsonObject $ckStr
set strVal [CkJsonObject_get_pathPrefix $myJsonObject]
CkJsonObject_put_PathPrefix $myJsonObject $strVal
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
set intVal [CkJsonObject_get_Size $myJsonObject]
UncommonOptions
# ckStr is a CkString
CkJsonObject_get_UncommonOptions $myJsonObject $ckStr
set strVal [CkJsonObject_get_uncommonOptions $myJsonObject]
CkJsonObject_put_UncommonOptions $myJsonObject $strVal
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topUtf8
set boolVal [CkJsonObject_get_Utf8 $myJsonObject]
CkJsonObject_put_Utf8 $myJsonObject $boolVal
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
set boolVal [CkJsonObject_get_VerboseLogging $myJsonObject]
CkJsonObject_put_VerboseLogging $myJsonObject $boolVal
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
# ckStr is a CkString
CkJsonObject_get_Version $myJsonObject $ckStr
set strVal [CkJsonObject_get_version $myJsonObject]
Methods
AddArrayAt
# name is a string
set status [CkJsonObject_AddArrayAt $index $name]
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
# name is a string
# jarr is a CkJsonArray
set status [CkJsonObject_AddArrayCopyAt $index $name $jarr]
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
# name is a string
# value is a boolean
set status [CkJsonObject_AddBoolAt $index $name $value]
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
# name is a string
# value is an integer
set status [CkJsonObject_AddIntAt $index $name $value]
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
# name is a string
set status [CkJsonObject_AddNullAt $index $name]
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
# name is a string
# numericStr is a string
set status [CkJsonObject_AddNumberAt $index $name $numericStr]
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
# name is a string
set status [CkJsonObject_AddObjectAt $index $name]
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
# name is a string
# jsonObj is a CkJsonObject
set status [CkJsonObject_AddObjectCopyAt $index $name $jsonObj]
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
# name is a string
# value is a string
set status [CkJsonObject_AddStringAt $index $name $value]
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
# name is a string
set ret_jsonArray [CkJsonObject_AppendArray $name]
Appends a new and empty JSON array and returns it.
Important: The name is the member name, it is not a JSON path.
Returns NULL on failure
AppendArrayCopy
# jarr is a CkJsonArray
set status [CkJsonObject_AppendArrayCopy $name $jarr]
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
# value is a boolean
set status [CkJsonObject_AppendBool $name $value]
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
# value is an integer
set status [CkJsonObject_AppendInt $name $value]
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
# name is a string
set ret_jsonObject [CkJsonObject_AppendObject $name]
Appends a new and empty JSON object and returns it.
Important: The name is the member name, it is not a JSON path.
Returns NULL on failure
AppendObjectCopy
# jsonObj is a CkJsonObject
set status [CkJsonObject_AppendObjectCopy $name $jsonObj]
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
# value is a string
set status [CkJsonObject_AppendString $name $value]
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
# values is a CkStringTable
set status [CkJsonObject_AppendStringArray $name $values]
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
# index is an integer
set ret_jsonArray [CkJsonObject_ArrayAt $index]
Returns the JSON array that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns NULL on failure
ArrayOf
# jsonPath is a string
set ret_jsonArray [CkJsonObject_ArrayOf $jsonPath]
Returns the JSON array at the specified jsonPath.
Returns NULL on failure
BoolAt
set retBool [CkJsonObject_BoolAt $index]
Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
BoolOf
set retBool [CkJsonObject_BoolOf $jsonPath]
BytesOf
# encoding is a string
# bd is a CkBinData
set status [CkJsonObject_BytesOf $jsonPath $encoding $bd]
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
set ret_jsonObject [CkJsonObject_Clone]
DateOf
# dateTime is a CkDateTime
set status [CkJsonObject_DateOf $jsonPath $dateTime]
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
set status [CkJsonObject_Delete $name]
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
set status [CkJsonObject_DeleteAt $index]
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
# relpath is a string
# value is a string
# caseSensitive is a boolean
set retInt [CkJsonObject_DeleteRecords $arrayPath $relpath $value $caseSensitive]
Deletes JSON records in an array where a particular field equals or matches a value pattern. Returns the number of JSON records deleted.
topDtOf
# bLocal is a boolean
# dt is a CkDtObj
set status [CkJsonObject_DtOf $jsonPath $bLocal $dt]
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
set status [CkJsonObject_Emit $outStr]
set retStr [CkJsonObject_emit $myJsonObject]
Writes the JSON document (rooted at the caller) and returns as a string.
Returns 1 for success, 0 for failure.
EmitBd
set status [CkJsonObject_EmitBd $bd]
EmitSb
set status [CkJsonObject_EmitSb $sb]
EmitWithSubs
# omitEmpty is a boolean
# outStr is a CkString (output)
set status [CkJsonObject_EmitWithSubs $subs $omitEmpty $outStr]
set retStr [CkJsonObject_emitWithSubs $myJsonObject $subs $omitEmpty]
Emits the JSON document with variable substitutions applied. If omitEmpty is 1, then members having empty strings or empty arrays are omitted.
Returns 1 for success, 0 for failure.
FindObjectWithMember
# name is a string
set ret_jsonObject [CkJsonObject_FindObjectWithMember $name]
Recursively searches the JSON subtree rooted at the caller's node for a JSON object containing a member having a specified name. (If the caller is the root node of the entire JSON document, then the entire JSON document is searched.) Returns the first match or NULL if not found.
Returns NULL on failure
topFindRecord
# arrayPath is a string
# relPath is a string
# value is a string
# caseSensitive is a boolean
set ret_jsonObject [CkJsonObject_FindRecord $arrayPath $relPath $value $caseSensitive]
Finds a JSON record in an array where a particular field equals or matches a value pattern. Reviewing the example below is the best way to understand this function.
Returns NULL on failure
FindRecordString
# relPath is a string
# value is a string
# caseSensitive is a boolean
# retRelPath is a string
# outStr is a CkString (output)
set status [CkJsonObject_FindRecordString $arrayPath $relPath $value $caseSensitive $retRelPath $outStr]
set retStr [CkJsonObject_findRecordString $myJsonObject $arrayPath $relPath $value $caseSensitive $retRelPath]
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 1 for success, 0 for failure.
FirebaseApplyEvent
# data is a string
set status [CkJsonObject_FirebaseApplyEvent $name $data]
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
# jsonData is a string
set status [CkJsonObject_FirebasePatch $jsonPath $jsonData]
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
# value is a string
set status [CkJsonObject_FirebasePut $jsonPath $value]
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
set ret_jsonObject [CkJsonObject_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 NULL on failure
HasMember
set status [CkJsonObject_HasMember $jsonPath]
IndexOf
set retInt [CkJsonObject_IndexOf $name]
Returns the index of the member having the given name. Returns -1 if the name is not found.
IntAt
set retInt [CkJsonObject_IntAt $index]
Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
IntOf
set retInt [CkJsonObject_IntOf $jsonPath]
IsNullAt
set retBool [CkJsonObject_IsNullAt $index]
Returns the boolean value of the member having the specified index.
IsNullOf
set retBool [CkJsonObject_IsNullOf $jsonPath]
Returns 1 if the value at the specified jsonPath is null. Otherwise returns 0.
JsonTypeOf
set retInt [CkJsonObject_JsonTypeOf $jsonPath]
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
set status [CkJsonObject_Load $json]
Parses a JSON string and loads it into this JSON object to provide DOM-style access.
Returns 1 for success, 0 for failure.
LoadBd
set status [CkJsonObject_LoadBd $bd]
LoadFile
set status [CkJsonObject_LoadFile $path]
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
set status [CkJsonObject_LoadPredefined $name]
Loads this JSON object from a predefined document having a specified name.
Returns 1 for success, 0 for failure.
LoadSb
set status [CkJsonObject_LoadSb $sb]
Loads JSON from the contents of a StringBuilder object.
Returns 1 for success, 0 for failure.
MoveMember
# toIndex is an integer
set status [CkJsonObject_MoveMember $fromIndex $toIndex]
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
# outStr is a CkString (output)
set status [CkJsonObject_NameAt $index $outStr]
set retStr [CkJsonObject_nameAt $myJsonObject $index]
Returns the name of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
ObjectAt
# index is an integer
set ret_jsonObject [CkJsonObject_ObjectAt $index]
Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns NULL on failure
ObjectOf
# jsonPath is a string
set ret_jsonObject [CkJsonObject_ObjectOf $jsonPath]
Returns the JSON object at the specified jsonPath.
Returns NULL on failure
Predefine
set status [CkJsonObject_Predefine $name]
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
# newName is a string
set status [CkJsonObject_Rename $oldName $newName]
Renames the member named oldName to newName.
Returns 1 for success, 0 for failure.
RenameAt
# name is a string
set status [CkJsonObject_RenameAt $index $name]
Renames the member at index to name.
Returns 1 for success, 0 for failure.
SetBoolAt
# value is a boolean
set status [CkJsonObject_SetBoolAt $index $value]
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
# value is a boolean
set status [CkJsonObject_SetBoolOf $jsonPath $value]
Sets the boolean value at the specified jsonPath.
Returns 1 for success, 0 for failure.
SetIntAt
# value is an integer
set status [CkJsonObject_SetIntAt $index $value]
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
# value is an integer
set status [CkJsonObject_SetIntOf $jsonPath $value]
Sets the integer at the specified jsonPath.
Returns 1 for success, 0 for failure.
SetNullAt
set status [CkJsonObject_SetNullAt $index]
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
set status [CkJsonObject_SetNullOf $jsonPath]
Sets the value at the specified jsonPath to null.
Returns 1 for success, 0 for failure.
SetNumberAt
# value is a string
set status [CkJsonObject_SetNumberAt $index $value]
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
# value is a string
set status [CkJsonObject_SetNumberOf $jsonPath $value]
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
# value is a string
set status [CkJsonObject_SetStringAt $index $value]
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
# value is a string
set status [CkJsonObject_SetStringOf $jsonPath $value]
Sets the string value at the specified jsonPath.
Returns 1 for success, 0 for failure.
SizeOfArray
set retInt [CkJsonObject_SizeOfArray $jsonPath]
Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.
Sort
# caseSensitive is a boolean
CkJsonObject_Sort $ascending $caseSensitive
StringAt
# outStr is a CkString (output)
set status [CkJsonObject_StringAt $index $outStr]
set retStr [CkJsonObject_stringAt $myJsonObject $index]
Returns 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.
StringOf
# outStr is a CkString (output)
set status [CkJsonObject_StringOf $jsonPath $outStr]
set retStr [CkJsonObject_stringOf $myJsonObject $jsonPath]
Returns the string value at the specified jsonPath.
Returns 1 for success, 0 for failure.
StringOfEquals
# value is a string
# caseSensitive is a boolean
set retBool [CkJsonObject_StringOfEquals $jsonPath $value $caseSensitive]
Returns 1 if the string value at the specified jsonPath equals value. Otherwise returns 0
topStringOfSb
# sb is a CkStringBuilder
set status [CkJsonObject_StringOfSb $jsonPath $sb]
Swap
# index2 is an integer
set status [CkJsonObject_Swap $index1 $index2]
Swaps the positions of members at index1 and index2.
Returns 1 for success, 0 for failure.
TypeAt
set retInt [CkJsonObject_TypeAt $index]
Returns the type of data at the given index. Possible return values are:
- string
- number
- object
- array
- boolean
- null
UIntOf
set retInt [CkJsonObject_UIntOf $jsonPath]
Returns the unsigned integer at the specified jsonPath.
topUpdateBd
# encoding is a string
# bd is a CkBinData
set status [CkJsonObject_UpdateBd $jsonPath $encoding $bd]
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
# value is a boolean
set status [CkJsonObject_UpdateBool $jsonPath $value]
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
# value is an integer
set status [CkJsonObject_UpdateInt $jsonPath $value]
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
set status [CkJsonObject_UpdateNewArray $jsonPath]
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
set status [CkJsonObject_UpdateNewObject $jsonPath]
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
set status [CkJsonObject_UpdateNull $jsonPath]
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
# numericStr is a string
set status [CkJsonObject_UpdateNumber $jsonPath $numericStr]
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
# sb is a CkStringBuilder
set status [CkJsonObject_UpdateSb $jsonPath $sb]
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
# value is a string
set status [CkJsonObject_UpdateString $jsonPath $value]
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
# value is an integer
set status [CkJsonObject_UpdateUInt $jsonPath $value]
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.
topWriteFile
set status [CkJsonObject_WriteFile $path]