JsonObject Delphi DLL 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.
Create/Dispose
var myObject: HCkJsonObject; begin myObject := CkJsonObject_Create(); // ... CkJsonObject_Dispose(myObject); end;
Creates an instance of the HCkJsonObject object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkJsonObject_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.
Properties
DebugLogFilePath
procedure CkJsonObject_putDebugLogFilePath(objHandle: HCkJsonObject; newPropVal: PWideChar); stdcall;
function CkJsonObject__debugLogFilePath(objHandle: HCkJsonObject): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
DelimiterChar
procedure CkJsonObject_putDelimiterChar(objHandle: HCkJsonObject; newPropVal: PWideChar); stdcall;
function CkJsonObject__delimiterChar(objHandle: HCkJsonObject): PWideChar; stdcall;
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.)
See the notes about PWideChar memory ownership and validity.
topEmitCompact
procedure CkJsonObject_putEmitCompact(objHandle: HCkJsonObject; newPropVal: wordbool); stdcall;
If True then the Emit method outputs in the most compact form possible (a single-line with no extra whitespace). If False, then emits with whitespace and indentation to make the JSON human-readable.
The default value is True.
topEmitCrLf
procedure CkJsonObject_putEmitCrLf(objHandle: HCkJsonObject; newPropVal: wordbool); stdcall;
If True then the Emit method uses CRLF line-endings when emitting the non-compact (pretty-print) format. If False, 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 True.
topI
procedure CkJsonObject_putI(objHandle: HCkJsonObject; newPropVal: Integer); stdcall;
The value of the "i" index to be used when evaluating a JSON path.
J
procedure CkJsonObject_putJ(objHandle: HCkJsonObject; newPropVal: Integer); stdcall;
The value of the "j" index to be used when evaluating a JSON path.
topK
procedure CkJsonObject_putK(objHandle: HCkJsonObject; newPropVal: Integer); stdcall;
The value of the "k" index to be used when evaluating a JSON path.
topLastErrorHtml
function CkJsonObject__lastErrorHtml(objHandle: HCkJsonObject): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkJsonObject__lastErrorText(objHandle: HCkJsonObject): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkJsonObject__lastErrorXml(objHandle: HCkJsonObject): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkJsonObject_putLastMethodSuccess(objHandle: HCkJsonObject; newPropVal: wordbool); stdcall;
Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
- 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topLowerCaseNames
procedure CkJsonObject_putLowerCaseNames(objHandle: HCkJsonObject; newPropVal: wordbool); stdcall;
If True 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 False.
topPathPrefix
procedure CkJsonObject_putPathPrefix(objHandle: HCkJsonObject; newPropVal: PWideChar); stdcall;
function CkJsonObject__pathPrefix(objHandle: HCkJsonObject): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topSize
UncommonOptions
procedure CkJsonObject_putUncommonOptions(objHandle: HCkJsonObject; newPropVal: PWideChar); stdcall;
function CkJsonObject__uncommonOptions(objHandle: HCkJsonObject): PWideChar; stdcall;
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
See the notes about PWideChar memory ownership and validity.
topVerboseLogging
procedure CkJsonObject_putVerboseLogging(objHandle: HCkJsonObject; newPropVal: wordbool); stdcall;
If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
function CkJsonObject__version(objHandle: HCkJsonObject): PWideChar; stdcall;
Version of the component/library, such as "9.5.0.94"
See the notes about PWideChar memory ownership and validity.
Methods
AddArrayAt
index: Integer;
name: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
AddArrayCopyAt
index: Integer;
name: PWideChar;
jarr: HCkJsonArray): wordbool; stdcall;
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 True for success, False for failure.
AddBoolAt
index: Integer;
name: PWideChar;
value: wordbool): wordbool; stdcall;
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 True for success, False for failure.
AddIntAt
index: Integer;
name: PWideChar;
value: Integer): wordbool; stdcall;
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 True for success, False for failure.
AddNullAt
index: Integer;
name: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
AddNumberAt
index: Integer;
name: PWideChar;
numericStr: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
AddObjectAt
index: Integer;
name: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
AddObjectCopyAt
index: Integer;
name: PWideChar;
jsonObj: HCkJsonObject): wordbool; stdcall;
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 True for success, False for failure.
AddStringAt
index: Integer;
name: PWideChar;
value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
AppendArray
name: PWideChar): HCkJsonArray; stdcall;
Appends a new and empty JSON array and returns it.
Important: The name is the member name, it is not a JSON path.
Returns nil on failure
AppendArrayCopy
name: PWideChar;
jarr: HCkJsonArray): wordbool; stdcall;
Appends a copy of a JSON array.
Important: The name is the member name, it is not a JSON path.
Returns True for success, False for failure.
AppendBool
name: PWideChar;
value: wordbool): wordbool; stdcall;
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 True for success, False for failure.
topAppendInt
name: PWideChar;
value: Integer): wordbool; stdcall;
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 True for success, False for failure.
topAppendObject
name: PWideChar): HCkJsonObject; stdcall;
Appends a new and empty JSON object and returns it.
Important: The name is the member name, it is not a JSON path.
Returns nil on failure
AppendObjectCopy
name: PWideChar;
jsonObj: HCkJsonObject): wordbool; stdcall;
Appends a copy of a JSON object.
Important: The name is the member name, it is not a JSON path.
Returns True for success, False for failure.
AppendString
name: PWideChar;
value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
topAppendStringArray
name: PWideChar;
values: HCkStringTable): wordbool; stdcall;
Appends an array of string values.
Important: The name is the member name, it is not a JSON path.
Returns True for success, False 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 nil on failure
ArrayOf
jsonPath: PWideChar): HCkJsonArray; stdcall;
Returns the JSON array at the specified jsonPath.
Returns nil on failure
BoolAt
index: Integer): wordbool; stdcall;
Returns the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
BoolOf
jsonPath: PWideChar): wordbool; stdcall;
BytesOf
jsonPath: PWideChar;
encoding: PWideChar;
bd: HCkBinData): wordbool; stdcall;
Appends the binary bytes at the specified jsonPath to bd. The encoding indicates the encoding of the bytes, such as "base64", "hex", etc.
Returns True for success, False for failure.
Clear
Clears the contents of the JSON object. This is the equivalent of calling jsonObject.Load("{}")
topClone
DateOf
jsonPath: PWideChar;
dateTime: HCkDateTime): wordbool; stdcall;
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 True for success, False for failure.
Delete
name: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
DeleteAt
index: Integer): wordbool; stdcall;
Deletes the member at index index. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
DeleteRecords
arrayPath: PWideChar;
relpath: PWideChar;
value: PWideChar;
caseSensitive: wordbool): Integer; stdcall;
Deletes JSON records in an array where a particular field equals or matches a value pattern. Returns the number of JSON records deleted.
topDtOf
jsonPath: PWideChar;
bLocal: wordbool;
dt: HCkDtObj): wordbool; stdcall;
Fills the dt with the date/time string located at jsonPath. If bLocal is True, 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 True for success, False for failure.
Emit
outStr: HCkString): wordbool; stdcall;
function CkJsonObject__emit(objHandle: HCkJsonObject): PWideChar; stdcall;
Writes the JSON document (rooted at the caller) and returns as a string.
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
EmitBd
EmitSb
EmitWithSubs
subs: HCkHashtable;
omitEmpty: wordbool;
outStr: HCkString): wordbool; stdcall;
function CkJsonObject__emitWithSubs(objHandle: HCkJsonObject;
subs: HCkHashtable;
omitEmpty: wordbool): PWideChar; stdcall;
Emits the JSON document with variable substitutions applied. If omitEmpty is True, then members having empty strings or empty arrays are omitted.
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
FindObjectWithMember
name: PWideChar): HCkJsonObject; stdcall;
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 nil if not found.
Returns nil on failure
topFindRecord
arrayPath: PWideChar;
relPath: PWideChar;
value: PWideChar;
caseSensitive: wordbool): HCkJsonObject; stdcall;
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 nil on failure
FindRecordString
arrayPath: PWideChar;
relPath: PWideChar;
value: PWideChar;
caseSensitive: wordbool;
retRelPath: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkJsonObject__findRecordString(objHandle: HCkJsonObject;
arrayPath: PWideChar;
relPath: PWideChar;
value: PWideChar;
caseSensitive: wordbool;
retRelPath: PWideChar): PWideChar; stdcall;
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 True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
FirebaseApplyEvent
name: PWideChar;
data: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
FirebasePatch
jsonPath: PWideChar;
jsonData: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
FirebasePut
jsonPath: PWideChar;
value: PWideChar): wordbool; stdcall;
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 True for success, False 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 nil on failure
HasMember
jsonPath: PWideChar): wordbool; stdcall;
IndexOf
name: PWideChar): Integer; stdcall;
Returns the index of the member having the given name. Returns -1 if the name is not found.
IntAt
index: Integer): Integer; stdcall;
Returns the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
IntOf
jsonPath: PWideChar): Integer; stdcall;
IsNullAt
index: Integer): wordbool; stdcall;
Returns the boolean value of the member having the specified index.
IsNullOf
jsonPath: PWideChar): wordbool; stdcall;
Returns True if the value at the specified jsonPath is null. Otherwise returns False.
JsonTypeOf
jsonPath: PWideChar): Integer; stdcall;
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
json: PWideChar): wordbool; stdcall;
Parses a JSON string and loads it into this JSON object to provide DOM-style access.
Returns True for success, False for failure.
LoadBd
LoadFile
path: PWideChar): wordbool; stdcall;
Loads a JSON file into this JSON object. The path is the file path to the JSON file.
Returns True for success, False for failure.
LoadPredefined
name: PWideChar): wordbool; stdcall;
Loads this JSON object from a predefined document having a specified name.
Returns True for success, False for failure.
LoadSb
Loads JSON from the contents of a StringBuilder object.
Returns True for success, False for failure.
MoveMember
fromIndex: Integer;
toIndex: Integer): wordbool; stdcall;
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 True for success, False for failure.
topNameAt
index: Integer;
outStr: HCkString): wordbool; stdcall;
function CkJsonObject__nameAt(objHandle: HCkJsonObject;
index: Integer): PWideChar; stdcall;
Returns the name of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
ObjectAt
index: Integer): HCkJsonObject; stdcall;
Returns the JSON object that is the value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns nil on failure
ObjectOf
jsonPath: PWideChar): HCkJsonObject; stdcall;
Returns the JSON object at the specified jsonPath.
Returns nil on failure
Predefine
name: PWideChar): wordbool; stdcall;
Adds or replaces this JSON to an internal global set of predefined JSON documents that can be subsequently loaded by name.
Returns True for success, False for failure.
Rename
oldName: PWideChar;
newName: PWideChar): wordbool; stdcall;
Renames the member named oldName to newName.
Returns True for success, False for failure.
RenameAt
index: Integer;
name: PWideChar): wordbool; stdcall;
Renames the member at index to name.
Returns True for success, False for failure.
SetBoolAt
index: Integer;
value: wordbool): wordbool; stdcall;
Sets the boolean value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
SetBoolOf
jsonPath: PWideChar;
value: wordbool): wordbool; stdcall;
Sets the boolean value at the specified jsonPath.
Returns True for success, False for failure.
SetIntAt
index: Integer;
value: Integer): wordbool; stdcall;
Sets the integer value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
SetIntOf
jsonPath: PWideChar;
value: Integer): wordbool; stdcall;
Sets the integer at the specified jsonPath.
Returns True for success, False for failure.
SetNullAt
index: Integer): wordbool; stdcall;
Sets the value of the Nth member to null. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
SetNullOf
jsonPath: PWideChar): wordbool; stdcall;
Sets the value at the specified jsonPath to null.
Returns True for success, False for failure.
SetNumberAt
index: Integer;
value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
SetNumberOf
jsonPath: PWideChar;
value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
SetStringAt
index: Integer;
value: PWideChar): wordbool; stdcall;
Sets the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
SetStringOf
jsonPath: PWideChar;
value: PWideChar): wordbool; stdcall;
Sets the string value at the specified jsonPath.
Returns True for success, False for failure.
SizeOfArray
jsonPath: PWideChar): Integer; stdcall;
Returns the size of the array at the given jsonPath. Returns -1 if the jsonPath does not evaluate to an existent JSON array.
Sort
ascending: wordbool;
caseSensitive: wordbool) stdcall;
StringAt
index: Integer;
outStr: HCkString): wordbool; stdcall;
function CkJsonObject__stringAt(objHandle: HCkJsonObject;
index: Integer): PWideChar; stdcall;
Returns the string value of the Nth member. Indexing is 0-based (the 1st member is at index 0).
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
StringOf
jsonPath: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkJsonObject__stringOf(objHandle: HCkJsonObject;
jsonPath: PWideChar): PWideChar; stdcall;
Returns the string value at the specified jsonPath.
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
StringOfEquals
jsonPath: PWideChar;
value: PWideChar;
caseSensitive: wordbool): wordbool; stdcall;
Returns True if the string value at the specified jsonPath equals value. Otherwise returns False
topStringOfSb
jsonPath: PWideChar;
sb: HCkStringBuilder): wordbool; stdcall;
Appends the string value at the specified jsonPath to sb.
Returns True for success, False for failure.
topSwap
index1: Integer;
index2: Integer): wordbool; stdcall;
Swaps the positions of members at index1 and index2.
Returns True for success, False for failure.
TypeAt
index: Integer): Integer; stdcall;
Returns the type of data at the given index. Possible return values are:
- string
- number
- object
- array
- boolean
- null
UIntOf
jsonPath: PWideChar): LongWord; stdcall;
Returns the unsigned integer at the specified jsonPath.
topUpdateBd
jsonPath: PWideChar;
encoding: PWideChar;
bd: HCkBinData): wordbool; stdcall;
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 True for success, False for failure.
UpdateBool
jsonPath: PWideChar;
value: wordbool): wordbool; stdcall;
Updates or appends a new boolean member. If the full path specified by jsonPath does not exist, it is automatically created as needed.
Returns True for success, False for failure.
topUpdateInt
jsonPath: PWideChar;
value: Integer): wordbool; stdcall;
Updates or appends a new integer member. If the full path specified by jsonPath does not exist, it is automatically created as needed.
Returns True for success, False for failure.
UpdateNewArray
jsonPath: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
UpdateNewObject
jsonPath: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
UpdateNull
jsonPath: PWideChar): wordbool; stdcall;
Updates or appends a null member. If the full path specified by jsonPath does not exist, it is automatically created as needed.
Returns True for success, False for failure.
topUpdateNumber
jsonPath: PWideChar;
numericStr: PWideChar): wordbool; stdcall;
Updates or appends a new numeric member. If the full path specified by jsonPath does not exist, it is automatically created as needed.
Returns True for success, False for failure.
UpdateSb
jsonPath: PWideChar;
sb: HCkStringBuilder): wordbool; stdcall;
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 True for success, False for failure.
topUpdateString
jsonPath: PWideChar;
value: PWideChar): wordbool; stdcall;
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 True for success, False for failure.
UpdateUInt
jsonPath: PWideChar;
value: LongWord): wordbool; stdcall;
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 True for success, False for failure.
topWriteFile
path: PWideChar): wordbool; stdcall;