TChilkatJsonArray Delphi ActiveX Reference Documentation
TChilkatJsonArray
Current Version: 10.1.0
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.
Importing the Chilkat ActiveX into Delphi
Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.
Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).
Two things are required to use an ActiveX in Delphi:
- The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
- See also: ActiveX Registration Tutorial
- The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.
To import the Chilkat type library, do the following:
- In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
- Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
- Check the "Generate Component Wrappers" checkbox.
- Select a directory where the unit files (.pas and .dcr) should be generated.
- Select "Create Unit" and then "Finish".
- Add the .pas to your Delphi project.
To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:
uses Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics, Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;
Object Creation
var obj: TChilkatJsonArray; ... begin obj := TChilkatJsonArray.Create(Self); ... // When finished, free the object instance. obj.Free();
Properties
DebugLogFilePath
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.
EmitCompact
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
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.
topLastBinaryResult
The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).
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
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.
topLastStringResult
The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topSize
The number of JSON values in the array.
topVerboseLogging
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.
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 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
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
Appends the array items contained in jarr.
Returns 1 for success, 0 for failure.
ArrayAt
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 nil on failure
BoolAt
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
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
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
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 a zero-length WideString on failure
topEmitSb
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
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
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
Returns the integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
IsNullAt
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
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
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
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 nil on failure
SetBoolAt
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
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
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
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
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
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
Returns the string value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
Returns a zero-length WideString on failure
Swap
TypeAt
Returns the type of data at the given index. Possible return values are:
- string
- number
- object
- array
- boolean
- null
UIntAt
Returns the unsigned integer value of the Nth array element. Indexing is 0-based (the 1st member is at index 0).
top