JsonArray Tcl Reference Documentation
JsonArray
Current Version: 10.1.2
Represents a JSON array, which contains an ordered list of JSON values, where each value can be a string, number, JSON object, JSON array, true, false, or null.
Object Creation
set myJsonArray [new CkJsonArray]
Properties
DebugLogFilePath
# ckStr is a CkString
CkJsonArray_get_DebugLogFilePath $myJsonArray $ckStr
set strVal [CkJsonArray_get_debugLogFilePath $myJsonArray]
CkJsonArray_put_DebugLogFilePath $myJsonArray $strVal
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.
EmitCompact
set boolVal [CkJsonArray_get_EmitCompact $myJsonArray]
CkJsonArray_put_EmitCompact $myJsonArray $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 [CkJsonArray_get_EmitCrlf $myJsonArray]
CkJsonArray_put_EmitCrlf $myJsonArray $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.
topLastErrorHtml
# ckStr is a CkString
CkJsonArray_get_LastErrorHtml $myJsonArray $ckStr
set strVal [CkJsonArray_get_lastErrorHtml $myJsonArray]
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
# ckStr is a CkString
CkJsonArray_get_LastErrorText $myJsonArray $ckStr
set strVal [CkJsonArray_get_lastErrorText $myJsonArray]
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
# ckStr is a CkString
CkJsonArray_get_LastErrorXml $myJsonArray $ckStr
set strVal [CkJsonArray_get_lastErrorXml $myJsonArray]
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
set boolVal [CkJsonArray_get_LastMethodSuccess $myJsonArray]
CkJsonArray_put_LastMethodSuccess $myJsonArray $boolVal
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
topSize
set intVal [CkJsonArray_get_Size $myJsonArray]
The number of JSON values in the array.
topUtf8
set boolVal [CkJsonArray_get_Utf8 $myJsonArray]
CkJsonArray_put_Utf8 $myJsonArray $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 [CkJsonArray_get_VerboseLogging $myJsonArray]
CkJsonArray_put_VerboseLogging $myJsonArray $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
CkJsonArray_get_Version $myJsonArray $ckStr
set strVal [CkJsonArray_get_version $myJsonArray]
Methods
AddArrayAt
set status [CkJsonArray_AddArrayAt $index]
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.
AddBoolAt
# value is a boolean
set status [CkJsonArray_AddBoolAt $index $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
# value is an integer
set status [CkJsonArray_AddIntAt $index $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
set status [CkJsonArray_AddNullAt $index]
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
# numericStr is a string
set status [CkJsonArray_AddNumberAt $index $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
set status [CkJsonArray_AddObjectAt $index]
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
# jsonObj is a CkJsonObject
set status [CkJsonArray_AddObjectCopyAt $index $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
# value is a string
set status [CkJsonArray_AddStringAt $index $value]
Inserts a new string at 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.
AddUIntAt
# value is an integer
set status [CkJsonArray_AddUIntAt $index $value]
Inserts a new unsigned 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.
topAppendArrayItems
set status [CkJsonArray_AppendArrayItems $jarr]
Appends the array items contained in jarr.
Returns 1 for success, 0 for failure.
ArrayAt
# index is an integer
set ret_jsonArray [CkJsonArray_ArrayAt $index]
Returns the JSON array that is the value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns NULL on failure
BoolAt
set retBool [CkJsonArray_BoolAt $index]
Returns the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
topClear
Deletes all array elements.
topDateAt
Fills the dateTime with the date/time string located in the Nth array element. Indexing is 0-based (the 1st member is at index 0). 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.
topDeleteAt
set status [CkJsonArray_DeleteAt $index]
Deletes the array element at the given index. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
DtAt
# bLocal is a boolean
# dt is a CkDtObj
set status [CkJsonArray_DtAt $index $bLocal $dt]
Fills the dt with the date/time string located in the Nth array element. If bLocal is 1, then dt is filled with the local date/time values, otherwise it is filled with the UTC/GMT values. Indexing is 0-based (the 1st member is at index 0). 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.
topEmit
set status [CkJsonArray_Emit $outStr]
set retStr [CkJsonArray_emit $myJsonArray]
Writes the JSON array (rooted at the caller) and returns as a string.
Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.
Returns 1 for success, 0 for failure.
topEmitSb
set status [CkJsonArray_EmitSb $sb]
Writes the JSON array to the sb.
Note: To control the compact/non-compact format, and to control the LF/CRLF line-endings, set the EmitCompact and EmitCrlf properties.
Returns 1 for success, 0 for failure.
FindObject
# value is a string
# caseSensitive is a boolean
set retInt [CkJsonArray_FindObject $name $value $caseSensitive]
Return the index of the first object in the array where value of the field at name matches value. name is an object member name. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is 0, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.
FindString
# caseSensitive is a boolean
set retInt [CkJsonArray_FindString $value $caseSensitive]
Return the index of the first matching string in the array. The value is a value pattern which can use "*" chars to indicate zero or more of any char. If caseSensitive is 0, then the matching is case insenstive, otherwise it is case sensitive. Returns -1 if no matching string was found.
topIntAt
set retInt [CkJsonArray_IntAt $index]
Returns the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
IsNullAt
set retBool [CkJsonArray_IsNullAt $index]
Returns the 1 if the Nth array element is null, otherwise returns 0. Indexing is 0-based (the 1st member is at index 0).
Load
set status [CkJsonArray_Load $jsonArray]
Loads a JSON array from a string. A JSON array must begin with a "[" and end with a "]".
Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.
Returns 1 for success, 0 for failure.
LoadSb
set status [CkJsonArray_LoadSb $sb]
Loads a JSON array from a StringBuilder. A JSON array must begin with a "[" and end with a "]".
Note: The Load method causes the JsonArray to detach and become it's own JSON document. It should only be called on new instances of the JsonArray. See the example below.
Returns 1 for success, 0 for failure.
ObjectAt
# index is an integer
set ret_jsonObject [CkJsonArray_ObjectAt $index]
Returns the JSON object that is the value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns NULL on failure
SetBoolAt
# value is a boolean
set status [CkJsonArray_SetBoolAt $index $value]
Sets the boolean value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
SetIntAt
# value is an integer
set status [CkJsonArray_SetIntAt $index $value]
Sets the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
SetNullAt
set status [CkJsonArray_SetNullAt $index]
Sets the Nth array element to the value of null. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
topSetNumberAt
# value is a string
set status [CkJsonArray_SetNumberAt $index $value]
Sets the numeric value of the Nth array element. 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.
SetStringAt
# value is a string
set status [CkJsonArray_SetStringAt $index $value]
Sets the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
SetUIntAt
# value is an integer
set status [CkJsonArray_SetUIntAt $index $value]
Sets the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
topStringAt
# outStr is a CkString (output)
set status [CkJsonArray_StringAt $index $outStr]
set retStr [CkJsonArray_stringAt $myJsonArray $index]
Returns the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns 1 for success, 0 for failure.
Swap
# index2 is an integer
set status [CkJsonArray_Swap $index1 $index2]
TypeAt
set retInt [CkJsonArray_TypeAt $index]
Returns the type of data at the given index. Possible return values are:
- string
- number
- object
- array
- boolean
- null
UIntAt
set retInt [CkJsonArray_UIntAt $index]
Returns the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
top