---
product: Chilkat
product_version: 11.7.0
language: powerbuilder
language_label: PowerBuilder
class: JsonObject
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/powerbuilder_JsonObjectRef.html
---
# Chilkat JsonObject — PowerBuilder — v11.7.0

> Chilkat 11.7.0 · language=powerbuilder · class=JsonObject
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/JsonObject.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/guide.md`.

## Purpose

**Load, navigate, create, modify, search, sort, and emit JSON objects.**

`Chilkat.JsonObject` provides DOM-style access to JSON objects. It can load, inspect, modify, create, search, sort, emit, and save JSON data. It supports path-based access, index-based member access, automatic creation of nested paths, object and array references, Firebase-style updates, record searches, date/time conversion, binary data encoding, variable substitution, and optional secure secret resolution.

**Load and emit JSON**

Load JSON from strings, files, buffers, or Chilkat objects, then emit the result as compact or pretty-formatted JSON.

**Path-based navigation**

Read and update nested values using JSON paths, with support for automatically creating missing object or array paths.

**Member access**

Access object members by name or index, inspect member types, retrieve values, and remove or rename members as needed.

**Nested objects and arrays**

Work directly with child `JsonObject` and `JsonArray` references to navigate and modify complex JSON structures.

**Search and transform**

Search records, sort object members, perform Firebase-style updates, and prepare JSON for API requests or application storage.

**Special value handling**

Handle date/time values, binary data encodings, exact numeric text, variable substitution, and secure secret resolution.

**Common pattern:** Load or create a `JsonObject`, navigate named members and nested paths, retrieve child arrays as `JsonArray` objects when ordered lists are encountered, update values as needed, then emit or save the final JSON. Use `JsonObject` for named JSON members and `JsonArray` for ordered lists.

For an extended overview, see [JsonObject Class Overview](https://www.chilkatsoft.com/jsonobject_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```powerbuilder
oleobject loo_JsonObject
integer li_rc

loo_JsonObject = create oleobject
li_rc = loo_JsonObject.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonObject
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_JsonObject ...

destroy loo_JsonObject
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.JsonObject.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in PowerBuilder.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `string DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `blob LastBinaryResult (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `DelimiterChar` | property, read/write | `string DelimiterChar` |
| `EmitCompact` | property, read/write | `long EmitCompact` |
| `EmitCrLf` | property, read/write | `long EmitCrLf` |
| `EnableSecrets` | property, read/write | `long EnableSecrets` |
| `I` | property, read/write | `long I` |
| `J` | property, read/write | `long J` |
| `K` | property, read/write | `long K` |
| `LowerCaseNames` | property, read/write | `long LowerCaseNames` |
| `PathPrefix` | property, read/write | `string PathPrefix` |
| `Size` | property, read-only | `long Size (read-only)` |
| `Strict` | property, read/write | `long Strict` |
| `UncommonOptions` | property, read/write | `string UncommonOptions` |
| `AddArrayAt` | method | `long AddArrayAt(long index, string name)` |
| `AddArrayCopyAt` | method | `long AddArrayCopyAt(long index, string name, ChilkatJsonArray jarr)` |
| `AddBoolAt` | method | `long AddBoolAt(long index, string name, long value)` |
| `AddIntAt` | method | `long AddIntAt(long index, string name, long value)` |
| `AddNullAt` | method | `long AddNullAt(long index, string name)` |
| `AddNumberAt` | method | `long AddNumberAt(long index, string name, string numericStr)` |
| `AddObjectAt` | method | `long AddObjectAt(long index, string name)` |
| `AddObjectCopyAt` | method | `long AddObjectCopyAt(long index, string name, ChilkatJsonObject jsonObj)` |
| `AddStringAt` | method | `long AddStringAt(long index, string name, string value)` |
| `AppendArray` | method | `ChilkatJsonArray AppendArray(string name)` |
| `AppendArray2` | method | `long AppendArray2(string name, ChilkatJsonArray jarr)` |
| `AppendArrayCopy` | method | `long AppendArrayCopy(string name, ChilkatJsonArray jarr)` |
| `AppendBool` | method | `long AppendBool(string name, long value)` |
| `AppendInt` | method | `long AppendInt(string name, long value)` |
| `AppendObject` | method | `ChilkatJsonObject AppendObject(string name)` |
| `AppendObject2` | method | `long AppendObject2(string name, ChilkatJsonObject jsonObj)` |
| `AppendObjectCopy` | method | `long AppendObjectCopy(string name, ChilkatJsonObject jsonObj)` |
| `AppendString` | method | `long AppendString(string name, string value)` |
| `AppendStringArray` | method | `long AppendStringArray(string name, ChilkatStringTable values)` |
| `ArrayAt` | method | `ChilkatJsonArray ArrayAt(long index)` |
| `ArrayAt2` | method | `long ArrayAt2(long index, ChilkatJsonArray jarr)` |
| `ArrayOf` | method | `ChilkatJsonArray ArrayOf(string jsonPath)` |
| `ArrayOf2` | method | `long ArrayOf2(string jsonPath, ChilkatJsonArray jarr)` |
| `BoolAt` | method | `long BoolAt(long index)` |
| `BoolOf` | method | `long BoolOf(string jsonPath)` |
| `BytesOf` | method | `long BytesOf(string jsonPath, string encoding, ChilkatBinData bd)` |
| `Clear` | method | `Clear()` |
| `CopyRef` | method | `long CopyRef(ChilkatJsonObject jsonObj)` |
| `DateOf` | method | `long DateOf(string jsonPath, CkDateTime dt)` |
| `Delete` | method | `long Delete(string name)` |
| `DeleteAt` | method | `long DeleteAt(long index)` |
| `DeleteRecords` | method | `long DeleteRecords(string arrayPath, string relpath, string value, long caseSensitive)` |
| `DtOf` | method | `long DtOf(string jsonPath, long bLocal, DtObj dt)` |
| `Emit` | method | `string Emit()` |
| `EmitBd` | method | `long EmitBd(ChilkatBinData bd)` |
| `EmitSb` | method | `long EmitSb(ChilkatStringBuilder sb)` |
| `EmitWithSubs` | method | `string EmitWithSubs(ChilkatHashtable subs, long omitEmpty)` |
| `FindObjectWithMember` | method | `ChilkatJsonObject FindObjectWithMember(string name)` |
| `FindObjectWithMember2` | method | `long FindObjectWithMember2(string name, ChilkatJsonObject jsonObj)` |
| `FindRecord` | method | `ChilkatJsonObject FindRecord(string arrayPath, string relPath, string value, long caseSensitive)` |
| `FindRecord2` | method | `long FindRecord2(string arrayPath, string relPath, string value, long caseSensitive, ChilkatJsonObject jsonObj)` |
| `FindRecordString` | method | `string FindRecordString(string arrayPath, string relPath, string value, long caseSensitive, string retRelPath)` |
| `FirebaseApplyEvent` | method | `long FirebaseApplyEvent(string name, string data)` |
| `FirebasePatch` | method | `long FirebasePatch(string jsonPath, string jsonData)` |
| `FirebasePut` | method | `long FirebasePut(string jsonPath, string value)` |
| `GetDocRoot` | method | `ChilkatJsonObject GetDocRoot()` |
| `GetDocRoot2` | method | `long GetDocRoot2(ChilkatJsonObject docRoot)` |
| `HasMember` | method | `long HasMember(string jsonPath)` |
| `IndexOf` | method | `long IndexOf(string name)` |
| `IntAt` | method | `long IntAt(long index)` |
| `IntOf` | method | `long IntOf(string jsonPath)` |
| `IsNullAt` | method | `long IsNullAt(long index)` |
| `IsNullOf` | method | `long IsNullOf(string jsonPath)` |
| `JsonTypeOf` | method | `long JsonTypeOf(string jsonPath)` |
| `Load` | method | `long Load(string json)` |
| `LoadBd` | method | `long LoadBd(ChilkatBinData bd)` |
| `LoadFile` | method | `long LoadFile(string path)` |
| `LoadPredefined` | method | `long LoadPredefined(string name)` |
| `LoadSb` | method | `long LoadSb(ChilkatStringBuilder sb)` |
| `MakeCopy` | method | `long MakeCopy(ChilkatJsonObject json)` |
| `MoveMember` | method | `long MoveMember(long fromIndex, long toIndex)` |
| `NameAt` | method | `string NameAt(long index)` |
| `NewArrayOf` | method | `long NewArrayOf(string path, string jArr)` |
| `NewObjectOf` | method | `long NewObjectOf(string path, string jObj)` |
| `ObjectAt` | method | `ChilkatJsonObject ObjectAt(long index)` |
| `ObjectAt2` | method | `long ObjectAt2(long index, ChilkatJsonObject jsonObj)` |
| `ObjectOf` | method | `ChilkatJsonObject ObjectOf(string jsonPath)` |
| `ObjectOf2` | method | `long ObjectOf2(string jsonPath, ChilkatJsonObject jsonObj)` |
| `Predefine` | method | `long Predefine(string name)` |
| `Rename` | method | `long Rename(string oldName, string newName)` |
| `RenameAt` | method | `long RenameAt(long index, string name)` |
| `SetBoolAt` | method | `long SetBoolAt(long index, long value)` |
| `SetBoolOf` | method | `long SetBoolOf(string jsonPath, long value)` |
| `SetIntAt` | method | `long SetIntAt(long index, long value)` |
| `SetIntOf` | method | `long SetIntOf(string jsonPath, long value)` |
| `SetNullAt` | method | `long SetNullAt(long index)` |
| `SetNullOf` | method | `long SetNullOf(string jsonPath)` |
| `SetNumberAt` | method | `long SetNumberAt(long index, string value)` |
| `SetNumberOf` | method | `long SetNumberOf(string jsonPath, string value)` |
| `SetStringAt` | method | `long SetStringAt(long index, string value)` |
| `SetStringOf` | method | `long SetStringOf(string jsonPath, string value)` |
| `SizeOfArray` | method | `long SizeOfArray(string jsonPath)` |
| `Sort` | method | `Sort(long ascending, long caseSensitive)` |
| `StringAt` | method | `string StringAt(long index)` |
| `StringOf` | method | `string StringOf(string jsonPath)` |
| `StringOfEquals` | method | `long StringOfEquals(string jsonPath, string value, long caseSensitive)` |
| `StringOfSb` | method | `long StringOfSb(string jsonPath, ChilkatStringBuilder sb)` |
| `Swap` | method | `long Swap(long index1, long index2)` |
| `TypeAt` | method | `long TypeAt(long index)` |
| `UIntOf` | method | `long UIntOf(string jsonPath)` |
| `UpdateBd` | method | `long UpdateBd(string jsonPath, string encoding, ChilkatBinData bd)` |
| `UpdateBool` | method | `long UpdateBool(string jsonPath, long value)` |
| `UpdateInt` | method | `long UpdateInt(string jsonPath, long value)` |
| `UpdateNewArray` | method | `long UpdateNewArray(string jsonPath)` |
| `UpdateNewObject` | method | `long UpdateNewObject(string jsonPath)` |
| `UpdateNull` | method | `long UpdateNull(string jsonPath)` |
| `UpdateNumber` | method | `long UpdateNumber(string jsonPath, string numericStr)` |
| `UpdateSb` | method | `long UpdateSb(string jsonPath, ChilkatStringBuilder sb)` |
| `UpdateString` | method | `long UpdateString(string jsonPath, string value)` |
| `UpdateUInt` | method | `long UpdateUInt(string jsonPath, long value)` |
| `WriteFile` | method | `long WriteFile(string path)` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### JsonObject.DelimiterChar

`Chilkat 11.7.0 · powerbuilder · JsonObject · DelimiterChar · property · read/write · since 9.5.0.58`

```powerbuilder
string DelimiterChar
```

Specifies the character used to separate object-member names in Chilkat JSON paths. The default is `.`. Set it to `/` for Firebase-style paths. This property should contain exactly one character.

**Arrays in paths:** Array indexes continue to use square brackets, such as `orders[0].id`. If a member name itself contains a path-separator character, quote that path component with double quotes.

### JsonObject.EmitCompact

`Chilkat 11.7.0 · powerbuilder · JsonObject · EmitCompact · property · read/write · since 9.5.0.56`

```powerbuilder
long EmitCompact
```

Controls whether emitted JSON is compact or pretty-printed. The default is `1`.

|  |  |
| --- | --- |
| `1` | Emit a compact representation with no extra formatting whitespace. |
| `0` | Emit indented, human-readable JSON. |

**JSON semantics:** Formatting whitespace does not change the JSON data. Use compact output for transport/storage and pretty output for diagnostics or human review.

### JsonObject.EmitCrLf

`Chilkat 11.7.0 · powerbuilder · JsonObject · EmitCrLf · property · read/write · since 9.5.0.56`

```powerbuilder
long EmitCrLf
```

Controls line endings when pretty-printed JSON is emitted (`EmitCompact = 0`). The default is `1`.

|  |  |
| --- | --- |
| `1` | Use CRLF line endings. |
| `0` | Use LF line endings. |

**Compact output:** This setting has no effect when `EmitCompact` is `1` because compact JSON is emitted without formatting line breaks.

### JsonObject.EnableSecrets

`Chilkat 11.7.0 · powerbuilder · JsonObject · EnableSecrets · property · read/write · since 11.5.0`

```powerbuilder
long EnableSecrets
```

**Full documentation for this property (same in every language):** [More Detailed Information About EnableSecrets](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/secret_specification_strings.md)

Enables automatic resolution of Chilkat secret specification strings for supported string-setting methods. The default is `0`. When enabled, a value beginning with `!!` can identify a credential stored in Windows Credential Manager or Apple Keychain instead of embedding the literal secret in application code.

Secret specification format: `!![appName|]service[|domain]|username`.

This feature applies to `AddStringAt`, `AppendString`, `SetStringAt`, `SetStringOf`, `UpdateSb`, and `UpdateString`.

**Security:** Secret resolution changes where the string value comes from; the resulting JSON member still contains the resolved value. Avoid emitting or logging JSON that contains credentials unless that exposure is explicitly intended.

### JsonObject.I

`Chilkat 11.7.0 · powerbuilder · JsonObject · I · property · read/write · since 9.5.0.56`

```powerbuilder
long I
```

Supplies the integer substituted for `i` when a JSON path contains an array index such as `[i]`. This is useful for loop-based navigation without constructing a new path string for every iteration.

**Related properties:** The `J` and `K` properties provide the same substitution behavior for `[j]` and `[k]`.

### JsonObject.J

`Chilkat 11.7.0 · powerbuilder · JsonObject · J · property · read/write · since 9.5.0.56`

```powerbuilder
long J
```

Supplies the integer substituted for `j` when a JSON path contains `[j]`. It is commonly used with nested-array paths such as `matrix[i][j]`.

### JsonObject.K

`Chilkat 11.7.0 · powerbuilder · JsonObject · K · property · read/write · since 9.5.0.56`

```powerbuilder
long K
```

Supplies the integer substituted for `k` when a JSON path contains `[k]`. It can be combined with `I` and `J` for deeper nested-array traversal.

### JsonObject.LowerCaseNames

`Chilkat 11.7.0 · powerbuilder · JsonObject · LowerCaseNames · property · read/write · since 9.5.0.87`

```powerbuilder
long LowerCaseNames
```

If `1`, member names are converted to lowercase while JSON is loaded by `Load`, `LoadBd`, `LoadSb`, or `LoadFile`. The default is `0`.

**Important:** This changes member names in the parsed document; it is not merely a case-insensitive lookup mode. Use it only when normalizing names is intentional.

### JsonObject.PathPrefix

`Chilkat 11.7.0 · powerbuilder · JsonObject · PathPrefix · property · read/write · since 9.5.0.76`

```powerbuilder
string PathPrefix
```

Specifies a path prefix automatically prepended to JSON paths passed to path-based methods such as `StringOf`, `ObjectOf`, `UpdateString`, `SetBoolOf`, and `SizeOfArray`. The default is the empty string.

**Use case:** Set a prefix when many operations target the same nested object. The individual method calls can then use paths relative to that prefix.

### JsonObject.Size

`Chilkat 11.7.0 · powerbuilder · JsonObject · Size · property · read-only · since 9.5.0.56`

```powerbuilder
long Size (read-only)
```

Returns the number of direct name/value members in this JSON object. Nested members inside child objects are not included.

**JSON objects and order:** RFC 8259 defines a JSON object as an unordered collection of name/value pairs. Chilkat preserves a member order so index-based APIs and deterministic emission are possible, but interoperable application logic should generally use member names rather than depend on object order.

### JsonObject.Strict

`Chilkat 11.7.0 · powerbuilder · JsonObject · Strict · property · read/write · since 11.6.0`

```powerbuilder
long Strict
```

When `Strict` is **true**, the Load methods first check that the data is well-formed JSON. If it is not, the load fails and the contents of this JsonObject are left **unchanged**. The default is `0`.

This applies to `Load`, `LoadSb`, `LoadBd`, `LoadFile` and `LoadPredefined`.

Chilkat's JSON parser is deliberately tolerant. By default it can accept text that is not well-formed, succeed, and leave an empty or partially populated document. That is convenient when the goal is a best-effort parse of imperfect input, but it is the wrong behavior when a silently missing member changes what the application does. A single missing comma, for example, can cause the members after it to be dropped while the load still reports success.

Set `Strict` to `1` for JSON carrying configuration, credentials, or security parameters, where a member that quietly failed to load would be acted on as though it had never been specified.

**Note:** The default is `0` so that existing applications are unaffected. When a strict load is rejected, this JsonObject keeps whatever it held before the call, so a failed reload never leaves the object empty.

### JsonObject.UncommonOptions

`Chilkat 11.7.0 · powerbuilder · JsonObject · UncommonOptions · property · read/write · since 9.5.0.90`

```powerbuilder
string UncommonOptions
```

Provides a catch-all string for uncommon, implementation-specific options. The default is the empty string and it should normally remain empty.

**Recommendation:** Do not invent option keywords. Set this property only when a specific `JsonObject` option is documented by Chilkat or provided by Chilkat support.

## Methods

### JsonObject.AddArrayAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddArrayAt · method · since 9.5.0.56`

```powerbuilder
long AddArrayAt(long index, string name)
```

Inserts a new JSON array member named `name` at the zero-based member position `index`. The new array is empty.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AddArrayCopyAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddArrayCopyAt · method · since 9.5.0.82`

```powerbuilder
long AddArrayCopyAt(long index, string name, ChilkatJsonArray jarr)
```

Inserts a new JSON array member named `name` at the zero-based member position `index`. The array value is copied from `jarr`; subsequent changes to the source array do not modify the inserted copy.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AddBoolAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddBoolAt · method · since 9.5.0.56`

```powerbuilder
long AddBoolAt(long index, string name, long value)
```

Inserts a new JSON boolean member named `name` at the zero-based member position `index`. The value is taken from `value`.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AddIntAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddIntAt · method · since 9.5.0.56`

```powerbuilder
long AddIntAt(long index, string name, long value)
```

Inserts a new JSON number member named `name` at the zero-based member position `index`. The integer `value` is emitted as a JSON number, not as a quoted string.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AddNullAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddNullAt · method · since 9.5.0.56`

```powerbuilder
long AddNullAt(long index, string name)
```

Inserts a new JSON null member named `name` at the zero-based member position `index`.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AddNumberAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddNumberAt · method · since 9.5.0.56`

```powerbuilder
long AddNumberAt(long index, string name, string numericStr)
```

Inserts a new JSON number member named `name` at the zero-based member position `index`. The `numericStr` argument supplies the exact JSON numeric text to store.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

**Exact numeric text:** Use this method when lexical form or precision matters, for example `12345678901234567890`, `1.2500`, or scientific notation. The supplied text must be valid JSON number syntax; JSON does not permit `NaN` or infinity.

Returns 1 for success, 0 for failure.

### JsonObject.AddObjectAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddObjectAt · method · since 9.5.0.56`

```powerbuilder
long AddObjectAt(long index, string name)
```

Inserts a new JSON object member named `name` at the zero-based member position `index`. The new object is empty.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AddObjectCopyAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddObjectCopyAt · method · since 9.5.0.82`

```powerbuilder
long AddObjectCopyAt(long index, string name, ChilkatJsonObject jsonObj)
```

Inserts a new JSON object member named `name` at the zero-based member position `index`. The object value is copied from `jsonObj`; the inserted value is independent of the source.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AddStringAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AddStringAt · method · since 9.5.0.56`

```powerbuilder
long AddStringAt(long index, string name, string value)
```

Inserts a new JSON string member named `name` at the zero-based member position `index`. The value is stored as a JSON string and is escaped as needed when emitted.

|  |  |
| --- | --- |
| `0` | Insert as the first member. |
| `-1` | Append as the last member. |
| `n` | Insert at zero-based position n. |

**Member name vs. JSON path:** `name` is a direct member name, not a JSON path. Use an `Update*` or `Set*Of` method when addressing a nested value by path.

Returns 1 for success, 0 for failure.

### JsonObject.AppendArray

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendArray · method · since 9.5.0.58`

```powerbuilder
ChilkatJsonArray AppendArray(string name)
```

Appends a new JSON array member named `name` to this object. The newly appended array is empty and the returned `JsonArray` references that array in this document, so changes made through it modify the same JSON tree.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns `null` on failure

### JsonObject.AppendArray2

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendArray2 · method · since 11.0.0`

```powerbuilder
long AppendArray2(string name, ChilkatJsonArray jarr)
```

Appends a new JSON array member named `name` to this object. A new empty array is created and `jarr` is updated to reference it. The method returns `1` on success.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.AppendArrayCopy

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendArrayCopy · method · since 9.5.0.82`

```powerbuilder
long AppendArrayCopy(string name, ChilkatJsonArray jarr)
```

Appends a new JSON array member named `name` to this object. The array is copied from `jarr`, so the appended array is independent of the source array.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.AppendBool

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendBool · method · since 9.5.0.58`

```powerbuilder
long AppendBool(string name, long value)
```

Appends a new JSON boolean member named `name` to this object. The value is taken from `value`.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.AppendInt

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendInt · method · since 9.5.0.58`

```powerbuilder
long AppendInt(string name, long value)
```

Appends a new JSON number member named `name` to this object. The integer value is stored as a JSON number.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.AppendObject

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendObject · method · since 9.5.0.58`

```powerbuilder
ChilkatJsonObject AppendObject(string name)
```

Appends a new JSON object member named `name` to this object. The newly appended object is empty and the returned `JsonObject` references that object in this document.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns `null` on failure

### JsonObject.AppendObject2

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendObject2 · method · since 11.0.0`

```powerbuilder
long AppendObject2(string name, ChilkatJsonObject jsonObj)
```

Appends a new JSON object member named `name` to this object. A new empty object is created and `jsonObj` is updated to reference it. The method returns `1` on success.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.AppendObjectCopy

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendObjectCopy · method · since 9.5.0.82`

```powerbuilder
long AppendObjectCopy(string name, ChilkatJsonObject jsonObj)
```

Appends a new JSON object member named `name` to this object. The object is copied from `jsonObj`, so the appended object is independent of the source object.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.AppendString

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendString · method · since 9.5.0.58`

```powerbuilder
long AppendString(string name, string value)
```

Appends a new JSON string member named `name` to this object. The value is JSON-escaped as needed when emitted.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.AppendStringArray

`Chilkat 11.7.0 · powerbuilder · JsonObject · AppendStringArray · method · since 9.5.0.67`

```powerbuilder
long AppendStringArray(string name, ChilkatStringTable values)
```

Appends a new JSON array member named `name` to this object. The array is populated with the strings contained in `values`.

**Member name vs. JSON path:** `name` is a direct member name. It is not interpreted as a JSON path. Use the corresponding `Update*` method when a nested path should be addressed or created.

Returns 1 for success, 0 for failure.

### JsonObject.ArrayAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · ArrayAt · method · since 9.5.0.56`

```powerbuilder
ChilkatJsonArray ArrayAt(long index)
```

Returns the JSON array stored in the member at zero-based position `index`. The returned `JsonArray` references the existing array in the same document; it is not a detached copy.

**Type requirement:** The member at `index` must be an array. Use `TypeAt` when the member type is not already known.

Returns `null` on failure

### JsonObject.ArrayAt2

`Chilkat 11.7.0 · powerbuilder · JsonObject · ArrayAt2 · method · since 11.0.0`

```powerbuilder
long ArrayAt2(long index, ChilkatJsonArray jarr)
```

Updates `jarr` to reference the JSON array stored at zero-based member position `index` and returns `1` on success.

Returns 1 for success, 0 for failure.

### JsonObject.ArrayOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · ArrayOf · method · since 9.5.0.56`

```powerbuilder
ChilkatJsonArray ArrayOf(string jsonPath)
```

Returns the JSON array at `jsonPath`. The returned `JsonArray` references the existing array in the same document, so modifications through it are reflected in the parent JSON.

**JSON paths:** Paths are relative to this object and may include object-member separators and array indexes, for example `orders[0].items`.

Returns `null` on failure

### JsonObject.ArrayOf2

`Chilkat 11.7.0 · powerbuilder · JsonObject · ArrayOf2 · method · since 11.1.0`

```powerbuilder
long ArrayOf2(string jsonPath, ChilkatJsonArray jarr)
```

Updates `jarr` to reference the JSON array at `jsonPath` and returns `1` on success.

Returns 1 for success, 0 for failure.

### JsonObject.BoolAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · BoolAt · method · since 9.5.0.56`

```powerbuilder
long BoolAt(long index)
```

Returns the boolean value of the member at zero-based position `index`.

**Indexing:** Member indexes are based on the order maintained by this `JsonObject` instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.

### JsonObject.BoolOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · BoolOf · method · since 9.5.0.56`

```powerbuilder
long BoolOf(string jsonPath)
```

Returns the boolean value at `jsonPath`. The path is evaluated relative to this `JsonObject`, after applying `PathPrefix` if one is set.

### JsonObject.BytesOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · BytesOf · method · since 9.5.0.68`

```powerbuilder
long BytesOf(string jsonPath, string encoding, ChilkatBinData bd)
```

Reads the string value at `jsonPath`, decodes it using `encoding` (for example, `base64` or `hex`), and appends the resulting bytes to `bd`.

**Binary-in-JSON convention:** The JSON member itself is text. The `encoding` argument tells Chilkat how that text represents the original bytes.

Returns 1 for success, 0 for failure.

### JsonObject.Clear

`Chilkat 11.7.0 · powerbuilder · JsonObject · Clear · method · since 9.5.0.76`

```powerbuilder
Clear()
```

Removes all members from this JSON object, leaving an empty object equivalent to `{}`.

### JsonObject.CopyRef

`Chilkat 11.7.0 · powerbuilder · JsonObject · CopyRef · method · since 11.0.0`

```powerbuilder
long CopyRef(ChilkatJsonObject jsonObj)
```

Updates `jsonObj` so that it references the same JSON object as the caller. No JSON data is copied.

**Shared state:** After this call, modifications through either reference affect the same underlying JSON object.

Returns 1 for success, 0 for failure.

### JsonObject.DateOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · DateOf · method · since 9.5.0.73`

```powerbuilder
long DateOf(string jsonPath, CkDateTime dt)
```

Parses the date/time value at `jsonPath` and loads the result into `dt`. Recognized forms include ISO 8601 timestamps (for example, `2009-11-04T19:55:41Z`), RFC 822-style date/time strings, and Unix timestamp integers.

**JSON has no native date type:** Dates in JSON are application conventions, usually represented as strings or numbers. This method recognizes common conventions and converts them to `CkDateTime`.

Returns 1 for success, 0 for failure.

### JsonObject.Delete

`Chilkat 11.7.0 · powerbuilder · JsonObject · Delete · method · since 9.5.0.56`

```powerbuilder
long Delete(string name)
```

Deletes the direct member named `name` from this JSON object.

**Not a path:** `name` is a member name, not a JSON path. Use a path-based operation when deleting or replacing a nested value requires navigation first.

Returns 1 for success, 0 for failure.

### JsonObject.DeleteAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · DeleteAt · method · since 9.5.0.56`

```powerbuilder
long DeleteAt(long index)
```

Deletes the member at zero-based position `index`. Members after the deleted position shift toward the beginning.

Returns 1 for success, 0 for failure.

### JsonObject.DeleteRecords

`Chilkat 11.7.0 · powerbuilder · JsonObject · DeleteRecords · method · since 9.5.0.88`

```powerbuilder
long DeleteRecords(string arrayPath, string relpath, string value, long caseSensitive)
```

Deletes every object record in the array at `arrayPath` whose value at relative path `relpath` equals or wildcard-matches `value`. The `caseSensitive` argument controls matching. Returns the number of records deleted.

### JsonObject.DtOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · DtOf · method · since 9.5.0.73`

```powerbuilder
long DtOf(string jsonPath, long bLocal, DtObj dt)
```

Parses the date/time value at `jsonPath` into `dt`. If `bLocal` is `1`, the destination receives local date/time fields; otherwise it receives UTC/GMT fields. Recognized inputs include ISO 8601 timestamps, RFC 822-style date/time strings, and Unix timestamp integers.

Returns 1 for success, 0 for failure.

### JsonObject.Emit

`Chilkat 11.7.0 · powerbuilder · JsonObject · Emit · method · since 9.5.0.56`

```powerbuilder
string Emit()
```

Serializes the JSON document rooted at this object and returns the JSON text. Formatting is controlled by `EmitCompact` and, for pretty output, `EmitCrLf`.

**Object member order:** Chilkat emits members in its maintained order, but JSON object ordering is not semantically significant under RFC 8259.

Returns `null` on failure

### JsonObject.EmitBd

`Chilkat 11.7.0 · powerbuilder · JsonObject · EmitBd · method · since 9.5.0.77`

```powerbuilder
long EmitBd(ChilkatBinData bd)
```

Serializes this JSON and appends the resulting bytes to `bd`.

**Append behavior:** Existing data in the destination `BinData` is preserved.

Returns 1 for success, 0 for failure.

### JsonObject.EmitSb

`Chilkat 11.7.0 · powerbuilder · JsonObject · EmitSb · method · since 9.5.0.62`

```powerbuilder
long EmitSb(ChilkatStringBuilder sb)
```

Serializes this JSON and appends the resulting text to `sb`. Formatting follows `EmitCompact` and `EmitCrLf`.

**Append behavior:** Existing text in the destination `StringBuilder` is preserved; the emitted JSON is added after it.

Returns 1 for success, 0 for failure.

### JsonObject.EmitWithSubs

`Chilkat 11.7.0 · powerbuilder · JsonObject · EmitWithSubs · method · since 9.5.0.67`

```powerbuilder
string EmitWithSubs(ChilkatHashtable subs, long omitEmpty)
```

Serializes the JSON after substituting variables from `subs` into template strings. A placeholder such as `{$name}` is replaced by the corresponding hashtable value. Prefixing the variable name with `i.`, as in `{$i.count}`, emits the substituted value as a JSON integer instead of a quoted string.

If `omitEmpty` is `1`, members whose substituted result is an empty string or empty array are omitted from the emitted JSON.

**Template reuse:** This method does not require rebuilding the JSON template. It is commonly paired with `Predefine` and `LoadPredefined` when the same JSON shape is emitted repeatedly with different values.

Returns `null` on failure

### JsonObject.FindObjectWithMember

`Chilkat 11.7.0 · powerbuilder · JsonObject · FindObjectWithMember · method · since 9.5.0.67`

```powerbuilder
ChilkatJsonObject FindObjectWithMember(string name)
```

Recursively searches this JSON subtree for the first JSON object containing a direct member named `name`. Returns that object, or `null` if no matching object is found.

Returns `null` on failure

### JsonObject.FindObjectWithMember2

`Chilkat 11.7.0 · powerbuilder · JsonObject · FindObjectWithMember2 · method · since 11.0.0`

```powerbuilder
long FindObjectWithMember2(string name, ChilkatJsonObject jsonObj)
```

Recursively searches this JSON subtree for the first object containing a direct member named `name`. On success, `jsonObj` is updated to reference the matching object and the method returns `1`.

Returns 1 for success, 0 for failure.

### JsonObject.FindRecord

`Chilkat 11.7.0 · powerbuilder · JsonObject · FindRecord · method · since 9.5.0.63`

```powerbuilder
ChilkatJsonObject FindRecord(string arrayPath, string relPath, string value, long caseSensitive)
```

Searches the JSON array at `arrayPath` for the first object whose value at relative path `relPath` equals or wildcard-matches `value`. The `caseSensitive` argument controls string comparison. Returns the matching record object.

**Wildcard matching:** The search value may contain `*` to match zero or more characters. `relPath` is evaluated relative to each record object in the array.

Returns `null` on failure

### JsonObject.FindRecord2

`Chilkat 11.7.0 · powerbuilder · JsonObject · FindRecord2 · method · since 11.0.0`

```powerbuilder
long FindRecord2(string arrayPath, string relPath, string value, long caseSensitive, ChilkatJsonObject jsonObj)
```

Searches the JSON array at `arrayPath` using the same matching rules as `FindRecord`. On success, `jsonObj` is updated to reference the first matching record and the method returns `1`.

**Reference semantics:** The destination references the record in the original JSON document; changes made through `jsonObj` modify that record.

Returns 1 for success, 0 for failure.

### JsonObject.FindRecordString

`Chilkat 11.7.0 · powerbuilder · JsonObject · FindRecordString · method · since 9.5.0.63`

```powerbuilder
string FindRecordString(string arrayPath, string relPath, string value, long caseSensitive, string retRelPath)
```

Searches the JSON array at `arrayPath` for the first record whose `relPath` value equals or wildcard-matches `value`, then returns the value at `retRelPath` from that same record as a string.

**Typical use:** This is useful for lookups such as “find the record where `Name` is `Advertising` and return its `Id`.” The `*` wildcard may be used in `value`.

Returns `null` on failure

### JsonObject.FirebaseApplyEvent

`Chilkat 11.7.0 · powerbuilder · JsonObject · FirebaseApplyEvent · method · since 9.5.0.58`

```powerbuilder
long FirebaseApplyEvent(string name, string data)
```

Applies a Firebase Realtime Database event to this JSON object. `name` should be `put` or `patch`, and `data` should contain event JSON such as `{"path":"/","data":{"a":1,"b":2}}`.

**Purpose:** This method is useful when maintaining a local JSON representation from Firebase server-sent events: `put` replaces the value at a path, while `patch` updates individual child keys.

Returns 1 for success, 0 for failure.

### JsonObject.FirebasePatch

`Chilkat 11.7.0 · powerbuilder · JsonObject · FirebasePatch · method · since 9.5.0.58`

```powerbuilder
long FirebasePatch(string jsonPath, string jsonData)
```

Applies Firebase-style patch semantics at `jsonPath`. `jsonData` must contain a JSON object; each key in that object updates or adds the corresponding key at the target path.

**Relative path:** `jsonPath` is relative to this `JsonObject`.

Returns 1 for success, 0 for failure.

### JsonObject.FirebasePut

`Chilkat 11.7.0 · powerbuilder · JsonObject · FirebasePut · method · since 9.5.0.58`

```powerbuilder
long FirebasePut(string jsonPath, string value)
```

Applies Firebase-style put semantics at `jsonPath`, replacing or inserting the value at that path. `value` is JSON text and may represent an object, array, number, boolean, `null`, or a quoted JSON string.

**Quoted strings:** To store a string through this method, `value` must contain a valid JSON string literal, including its surrounding double quotes. Use `UpdateString` when you already have an ordinary application string.

Returns 1 for success, 0 for failure.

### JsonObject.GetDocRoot

`Chilkat 11.7.0 · powerbuilder · JsonObject · GetDocRoot · method · since 9.5.0.56`

```powerbuilder
ChilkatJsonObject GetDocRoot()
```

Returns a `JsonObject` reference to the root object of the JSON document containing this object. This can be called from any nested object reference.

**Shared document lifetime:** Nested `JsonObject` references share the same underlying JSON document. The document remains available while at least one such reference is retained by the application.

Returns `null` on failure

### JsonObject.GetDocRoot2

`Chilkat 11.7.0 · powerbuilder · JsonObject · GetDocRoot2 · method · since 11.0.0`

```powerbuilder
long GetDocRoot2(ChilkatJsonObject docRoot)
```

Updates `docRoot` to reference the root object of the JSON document containing the caller and returns `1` on success.

**Reference semantics:** The destination is another reference into the same underlying document; it is not a copy.

Returns 1 for success, 0 for failure.

### JsonObject.HasMember

`Chilkat 11.7.0 · powerbuilder · JsonObject · HasMember · method · since 9.5.0.58`

```powerbuilder
long HasMember(string jsonPath)
```

Returns `1` if a value exists at `jsonPath`; otherwise returns `0`.

**Missing vs. null:** A member whose JSON value is `null` still exists. Use `IsNullOf` to test specifically for JSON `null`.

Returns 1 for success, 0 for failure.

### JsonObject.IndexOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · IndexOf · method · since 9.5.0.56`

```powerbuilder
long IndexOf(string name)
```

Returns the zero-based position of the direct member named `name`, or `-1` if that member name is not found.

**Not a path:** `name` is searched only among the direct members of this object.

### JsonObject.IntAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · IntAt · method · since 9.5.0.56`

```powerbuilder
long IntAt(long index)
```

Returns the integer value of the member at zero-based position `index`.

**Indexing:** Member indexes are based on the order maintained by this `JsonObject` instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.

### JsonObject.IntOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · IntOf · method · since 9.5.0.56`

```powerbuilder
long IntOf(string jsonPath)
```

Returns the integer value at `jsonPath`. The path is evaluated relative to this `JsonObject`, after applying `PathPrefix` if one is set.

**Large numbers:** Use `StringOf` or the exact numeric-text APIs when a JSON integer may exceed the range of the language binding's integer type.

### JsonObject.IsNullAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · IsNullAt · method · since 9.5.0.56`

```powerbuilder
long IsNullAt(long index)
```

Returns `1` if the member at zero-based position `index` has the JSON value `null`; otherwise returns `0`.

### JsonObject.IsNullOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · IsNullOf · method · since 9.5.0.56`

```powerbuilder
long IsNullOf(string jsonPath)
```

Returns `1` if the value at `jsonPath` is the JSON literal `null`; otherwise returns `0`.

**Null is a value:** JSON `null` is different from a missing member and from an empty string. Use `HasMember` when existence must be tested separately.

### JsonObject.JsonTypeOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · JsonTypeOf · method · since 9.5.0.68`

```powerbuilder
long JsonTypeOf(string jsonPath)
```

Returns an integer identifying the JSON type of the value at `jsonPath`. Returns `-1` if no member exists at that path.

|  |  |
| --- | --- |
| `1` | string |
| `2` | number |
| `3` | object |
| `4` | array |
| `5` | boolean |
| `6` | null |

### JsonObject.Load

`Chilkat 11.7.0 · powerbuilder · JsonObject · Load · method · since 9.5.0.56`

```powerbuilder
long Load(string json)
```

Parses the JSON text in `json` and loads the parsed data into this object for DOM-style access and modification.

**JSON data model:** JSON values are strings, numbers, booleans, `null`, objects, or arrays. Object member names should be unique for interoperable JSON; RFC 8259 notes that consumers differ in how duplicate names are handled.

Returns 1 for success, 0 for failure.

### JsonObject.LoadBd

`Chilkat 11.7.0 · powerbuilder · JsonObject · LoadBd · method · since 9.5.0.77`

```powerbuilder
long LoadBd(ChilkatBinData bd)
```

Parses JSON from the bytes contained in `bd` and loads it into this object.

Returns 1 for success, 0 for failure.

### JsonObject.LoadFile

`Chilkat 11.7.0 · powerbuilder · JsonObject · LoadFile · method · since 9.5.0.56`

```powerbuilder
long LoadFile(string path)
```

Reads JSON text from the file at `path`, parses it, and loads the result into this object.

Returns 1 for success, 0 for failure.

### JsonObject.LoadPredefined

`Chilkat 11.7.0 · powerbuilder · JsonObject · LoadPredefined · method · since 9.5.0.67`

```powerbuilder
long LoadPredefined(string name)
```

Loads this object from the predefined JSON document identified by `name`. Predefined documents are created with `Predefine`.

Returns 1 for success, 0 for failure.

### JsonObject.LoadSb

`Chilkat 11.7.0 · powerbuilder · JsonObject · LoadSb · method · since 9.5.0.62`

```powerbuilder
long LoadSb(ChilkatStringBuilder sb)
```

Parses JSON from the current contents of `sb` and loads it into this object.

Returns 1 for success, 0 for failure.

### JsonObject.MakeCopy

`Chilkat 11.7.0 · powerbuilder · JsonObject · MakeCopy · method · since 11.0.0`

```powerbuilder
long MakeCopy(ChilkatJsonObject json)
```

Copies this JSON object into `json`. The destination receives an independent JSON copy rather than another reference to the same underlying object.

**Copy vs. reference:** Use `CopyRef` when two `JsonObject` instances should refer to the same JSON object instead of duplicating its data.

Returns 1 for success, 0 for failure.

### JsonObject.MoveMember

`Chilkat 11.7.0 · powerbuilder · JsonObject · MoveMember · method · since 9.5.0.80`

```powerbuilder
long MoveMember(long fromIndex, long toIndex)
```

Moves the direct member at zero-based position `fromIndex` to `toIndex`. Use `toIndex = 0` to move it first or `-1` to move it last.

Returns 1 for success, 0 for failure.

### JsonObject.NameAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · NameAt · method · since 9.5.0.56`

```powerbuilder
string NameAt(long index)
```

Returns the name of the member at zero-based position `index`. Use this with `Size` and `TypeAt` to iterate through an object's direct members.

Returns `null` on failure

### JsonObject.NewArrayOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · NewArrayOf · method · since 11.4.0`

```powerbuilder
long NewArrayOf(string path, string jArr)
```

Creates a JSON array at `path` and loads that array from the JSON text in `jArr`. The supplied text should represent a JSON array.

**Difference from UpdateNewArray:** `UpdateNewArray` creates an empty array. `NewArrayOf` creates the array and immediately populates it from JSON text.

Returns 1 for success, 0 for failure.

### JsonObject.NewObjectOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · NewObjectOf · method · since 11.4.0`

```powerbuilder
long NewObjectOf(string path, string jObj)
```

Creates a JSON object at `path` and loads that object from the JSON text in `jObj`. The supplied text should represent a JSON object.

**Difference from UpdateNewObject:** `UpdateNewObject` creates an empty object. `NewObjectOf` creates the object and immediately populates it from JSON text.

Returns 1 for success, 0 for failure.

### JsonObject.ObjectAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · ObjectAt · method · since 9.5.0.56`

```powerbuilder
ChilkatJsonObject ObjectAt(long index)
```

Returns the JSON object stored in the member at zero-based position `index`. The returned `JsonObject` references the existing child object in the same document; changes made through it modify that document.

**Type requirement:** The member at `index` must be a JSON object. Use `TypeAt` when the type is not already known.

Returns `null` on failure

### JsonObject.ObjectAt2

`Chilkat 11.7.0 · powerbuilder · JsonObject · ObjectAt2 · method · since 11.0.0`

```powerbuilder
long ObjectAt2(long index, ChilkatJsonObject jsonObj)
```

Updates `jsonObj` to reference the JSON object stored at zero-based member position `index` and returns `1` on success.

Returns 1 for success, 0 for failure.

### JsonObject.ObjectOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · ObjectOf · method · since 9.5.0.56`

```powerbuilder
ChilkatJsonObject ObjectOf(string jsonPath)
```

Returns the JSON object at `jsonPath`. The returned object is a live reference into the same JSON document, not a copy.

**Relative paths:** A path is evaluated relative to the current object. Use `GetDocRoot` when access must start from the document root.

Returns `null` on failure

### JsonObject.ObjectOf2

`Chilkat 11.7.0 · powerbuilder · JsonObject · ObjectOf2 · method · since 11.0.0`

```powerbuilder
long ObjectOf2(string jsonPath, ChilkatJsonObject jsonObj)
```

Updates `jsonObj` to reference the JSON object at `jsonPath` and returns `1` on success.

Returns 1 for success, 0 for failure.

### JsonObject.Predefine

`Chilkat 11.7.0 · powerbuilder · JsonObject · Predefine · method · since 9.5.0.67`

```powerbuilder
long Predefine(string name)
```

Stores this JSON document in Chilkat's internal global collection of predefined JSON documents under `name`. If the name already exists, the predefined value is replaced.

**Template use:** After predefining a document, another `JsonObject` can load it by name with `LoadPredefined`.

Returns 1 for success, 0 for failure.

### JsonObject.Rename

`Chilkat 11.7.0 · powerbuilder · JsonObject · Rename · method · since 9.5.0.56`

```powerbuilder
long Rename(string oldName, string newName)
```

Renames the direct member `oldName` to `newName`. The member value and its position are otherwise unchanged.

**JSON interoperability:** JSON object member names should be unique. Avoid renaming a member to a name already used by another member unless duplicate names are intentionally required.

Returns 1 for success, 0 for failure.

### JsonObject.RenameAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · RenameAt · method · since 9.5.0.56`

```powerbuilder
long RenameAt(long index, string name)
```

Renames the member at zero-based position `index` to `name`. The member value is not changed.

Returns 1 for success, 0 for failure.

### JsonObject.SetBoolAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetBoolAt · method · since 9.5.0.56`

```powerbuilder
long SetBoolAt(long index, long value)
```

Sets the member at zero-based position `index` to a JSON boolean value.

Returns 1 for success, 0 for failure.

### JsonObject.SetBoolOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetBoolOf · method · since 9.5.0.56`

```powerbuilder
long SetBoolOf(string jsonPath, long value)
```

Sets the value at `jsonPath` to a JSON boolean value.

**Set vs. Update:** Use `UpdateBool` when missing objects or array positions along the path should be created automatically.

Returns 1 for success, 0 for failure.

### JsonObject.SetIntAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetIntAt · method · since 9.5.0.56`

```powerbuilder
long SetIntAt(long index, long value)
```

Sets the member at zero-based position `index` to a JSON number value. The integer is emitted as a JSON number.

Returns 1 for success, 0 for failure.

### JsonObject.SetIntOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetIntOf · method · since 9.5.0.56`

```powerbuilder
long SetIntOf(string jsonPath, long value)
```

Sets the value at `jsonPath` to an integer JSON number.

**Set vs. Update:** Use `UpdateInt` when missing objects or array positions along the path should be created automatically.

Returns 1 for success, 0 for failure.

### JsonObject.SetNullAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetNullAt · method · since 9.5.0.56`

```powerbuilder
long SetNullAt(long index)
```

Sets the member at zero-based position `index` to a JSON null value.

Returns 1 for success, 0 for failure.

### JsonObject.SetNullOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetNullOf · method · since 9.5.0.56`

```powerbuilder
long SetNullOf(string jsonPath)
```

Sets the value at `jsonPath` to a JSON null value.

**Set vs. Update:** Use `UpdateNull` when missing objects or array positions along the path should be created automatically.

Returns 1 for success, 0 for failure.

### JsonObject.SetNumberAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetNumberAt · method · since 9.5.0.56`

```powerbuilder
long SetNumberAt(long index, string value)
```

Sets the member at zero-based position `index` to a JSON number value. The `value` argument is the exact textual representation of the JSON number.

**JSON number syntax:** The text may contain an integer, fraction, or exponent. It must be valid JSON number syntax; leading zeros (except for zero itself), `NaN`, and infinity are not valid JSON numbers.

Returns 1 for success, 0 for failure.

### JsonObject.SetNumberOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetNumberOf · method · since 9.5.0.56`

```powerbuilder
long SetNumberOf(string jsonPath, string value)
```

Sets the value at `jsonPath` to a JSON number value. The `value` argument supplies the exact textual form of the JSON number.

**Set vs. Update:** Use `UpdateNumber` when missing objects or array positions along the path should be created automatically.

**Precision:** Using numeric text avoids an intermediate conversion through a floating-point type and can therefore preserve large integers or application-specific decimal formatting.

Returns 1 for success, 0 for failure.

### JsonObject.SetStringAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetStringAt · method · since 9.5.0.56`

```powerbuilder
long SetStringAt(long index, string value)
```

Sets the member at zero-based position `index` to a JSON string value. The string is escaped as required when JSON is emitted.

Returns 1 for success, 0 for failure.

### JsonObject.SetStringOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · SetStringOf · method · since 9.5.0.56`

```powerbuilder
long SetStringOf(string jsonPath, string value)
```

Sets the value at `jsonPath` to a JSON string value. The string is escaped as required when JSON is emitted.

**Set vs. Update:** Use `UpdateString` when missing objects or array positions along the path should be created automatically.

Returns 1 for success, 0 for failure.

### JsonObject.SizeOfArray

`Chilkat 11.7.0 · powerbuilder · JsonObject · SizeOfArray · method · since 9.5.0.56`

```powerbuilder
long SizeOfArray(string jsonPath)
```

Returns the number of elements in the JSON array at `jsonPath`. Returns `-1` if the path does not resolve to an existing JSON array.

### JsonObject.Sort

`Chilkat 11.7.0 · powerbuilder · JsonObject · Sort · method · since 9.5.0.100`

```powerbuilder
Sort(long ascending, long caseSensitive)
```

Sorts this object's direct members by member name. `ascending` selects ascending or descending order, and `caseSensitive` controls how names are compared.

**JSON semantics:** Member ordering is not significant to JSON consumers, but sorting can make emitted JSON deterministic and easier to compare or review.

### JsonObject.StringAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · StringAt · method · since 9.5.0.56`

```powerbuilder
string StringAt(long index)
```

Returns the string value of the member at zero-based position `index`.

**Indexing:** Member indexes are based on the order maintained by this `JsonObject` instance. JSON objects are semantically unordered, so application protocols should normally identify values by member name rather than by position.

**Non-string values:** `StringOf` can also provide textual representations of scalar JSON values such as numbers, booleans, and `null`; use the type-specific methods when the JSON type itself matters.

Returns `null` on failure

### JsonObject.StringOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · StringOf · method · since 9.5.0.56`

```powerbuilder
string StringOf(string jsonPath)
```

Returns the value at `jsonPath` as text. For a JSON string, the string value is returned. Scalar non-string values such as numbers, booleans, and `null` are returned using their JSON textual representation.

**Type-sensitive code:** Use `JsonTypeOf`, `IntOf`, `BoolOf`, or `IsNullOf` when the distinction between JSON types is important.

Returns `null` on failure

### JsonObject.StringOfEquals

`Chilkat 11.7.0 · powerbuilder · JsonObject · StringOfEquals · method · since 9.5.0.96`

```powerbuilder
long StringOfEquals(string jsonPath, string value, long caseSensitive)
```

Returns `1` if the textual value at `jsonPath` equals `value` according to the `caseSensitive` setting; otherwise returns `0`.

### JsonObject.StringOfSb

`Chilkat 11.7.0 · powerbuilder · JsonObject · StringOfSb · method · since 9.5.0.68`

```powerbuilder
long StringOfSb(string jsonPath, ChilkatStringBuilder sb)
```

Retrieves the value at `jsonPath` as text and appends it to `sb`.

**Append behavior:** Existing contents of the destination `StringBuilder` are preserved.

Returns 1 for success, 0 for failure.

### JsonObject.Swap

`Chilkat 11.7.0 · powerbuilder · JsonObject · Swap · method · since 9.5.0.76`

```powerbuilder
long Swap(long index1, long index2)
```

Swaps the positions of the direct members at zero-based indexes `index1` and `index2`. Member names and values are unchanged.

**Ordering:** JSON object order is not semantically significant, but Chilkat preserves an order for index-based access and emission.

Returns 1 for success, 0 for failure.

### JsonObject.TypeAt

`Chilkat 11.7.0 · powerbuilder · JsonObject · TypeAt · method · since 9.5.0.58`

```powerbuilder
long TypeAt(long index)
```

Returns an integer identifying the JSON type of the member at zero-based position `index`. Returns `-1` if no member exists at that index.

|  |  |
| --- | --- |
| `1` | string |
| `2` | number |
| `3` | object |
| `4` | array |
| `5` | boolean |
| `6` | null |

### JsonObject.UIntOf

`Chilkat 11.7.0 · powerbuilder · JsonObject · UIntOf · method · since 9.5.0.96`

```powerbuilder
long UIntOf(string jsonPath)
```

Returns the unsigned integer value at `jsonPath`.

### JsonObject.UpdateBd

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateBd · method · since 9.5.0.68`

```powerbuilder
long UpdateBd(string jsonPath, string encoding, ChilkatBinData bd)
```

Updates the value at `jsonPath` to a JSON string value, or creates the member and any missing path components as needed. The bytes in `bd` are first encoded according to `encoding` (for example, `base64` or `hex`) and the encoded text is stored as the JSON string value.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

**Binary data in JSON:** JSON has no native byte-array type. Binary content must therefore be represented using a textual encoding agreed upon by the producer and consumer.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateBool

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateBool · method · since 9.5.0.63`

```powerbuilder
long UpdateBool(string jsonPath, long value)
```

Updates the value at `jsonPath` to a JSON boolean value, or creates the member and any missing path components as needed.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateInt

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateInt · method · since 9.5.0.63`

```powerbuilder
long UpdateInt(string jsonPath, long value)
```

Updates the value at `jsonPath` to a JSON number value, or creates the member and any missing path components as needed. The integer value is stored as a JSON number.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateNewArray

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateNewArray · method · since 9.5.0.75`

```powerbuilder
long UpdateNewArray(string jsonPath)
```

Creates or replaces the value at `jsonPath` with a new empty JSON array. Missing path components are created automatically as needed.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateNewObject

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateNewObject · method · since 9.5.0.75`

```powerbuilder
long UpdateNewObject(string jsonPath)
```

Creates or replaces the value at `jsonPath` with a new empty JSON object. Missing path components are created automatically as needed.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateNull

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateNull · method · since 9.5.0.65`

```powerbuilder
long UpdateNull(string jsonPath)
```

Updates the value at `jsonPath` to a JSON null value, or creates the member and any missing path components as needed.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateNumber

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateNumber · method · since 9.5.0.65`

```powerbuilder
long UpdateNumber(string jsonPath, string numericStr)
```

Updates the value at `jsonPath` to a JSON number value, or creates the member and any missing path components as needed. The `numericStr` argument is stored as the exact textual representation of the JSON number.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

**When to use:** Use `UpdateNumber` instead of `UpdateInt` for decimal/exponent forms, very large integers, or when preserving exact numeric text is important.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateSb

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateSb · method · since 9.5.0.68`

```powerbuilder
long UpdateSb(string jsonPath, ChilkatStringBuilder sb)
```

Updates the value at `jsonPath` to a JSON string value, or creates the member and any missing path components as needed. The new string value is taken from the contents of `sb`.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateString

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateString · method · since 9.5.0.63`

```powerbuilder
long UpdateString(string jsonPath, string value)
```

Updates the value at `jsonPath` to a JSON string value, or creates the member and any missing path components as needed. The supplied string is JSON-escaped as needed.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

**Version note:** Chilkat versions prior to 9.5.0.68 did not correctly escape all characters for this method. Version 9.5.0.68 and later correct that behavior.

Returns 1 for success, 0 for failure.

### JsonObject.UpdateUInt

`Chilkat 11.7.0 · powerbuilder · JsonObject · UpdateUInt · method · since 9.5.0.96`

```powerbuilder
long UpdateUInt(string jsonPath, long value)
```

Updates the value at `jsonPath` to a JSON number value, or creates the member and any missing path components as needed. The unsigned integer is stored as a JSON number.

**Path-based operation:** `jsonPath` is interpreted using `DelimiterChar`, `PathPrefix`, and the `I`/`J`/`K` index substitutions.

Returns 1 for success, 0 for failure.

### JsonObject.WriteFile

`Chilkat 11.7.0 · powerbuilder · JsonObject · WriteFile · method · since 9.5.0.76`

```powerbuilder
long WriteFile(string path)
```

Serializes this JSON and writes it to the file at `path`. Output formatting follows `EmitCompact` and `EmitCrLf`.

Returns 1 for success, 0 for failure.

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `Clone` | method | before 11.6.1 | `MakeCopy` |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/CkDateTime.md), [`DtObj`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/DtObj.md), [`Hashtable`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/Hashtable.md), [`JsonArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/JsonArray.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/StringBuilder.md), [`StringTable`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/StringTable.md)

