Json.JsonDocument

Entry point for processing JSON data

WSupported on Windows
USupported on Unix
VSupported on OpenVMS

 

namespace Json
public class JsonDocument

The JsonDocument class provides a way to examine the structural content of a JSON value without automatically instantiating data values.

Methods

Parse

public static Parse(json), @JsonDocument

Parses the text in json, which is a string or memory handle (@string or D_HANDLE), into a JSON document.

Properties

RootElement

public RootElement, @JsonElement

Gets the root element of this JsonDocument.

Discussion

JsonDocument acts as a single reference point for all of its associated JsonElement objects. All resulting JsonElement objects that come from this JsonDocument, its properties, and its method are only valid while the JsonDocument is alive and valid. JsonElement objects do not maintain a reference count back to their parent JsonDocument and will not be valid if the JsonDocument is destroyed.

JsonDocument reduces the burden of garbage collection by using resources from pooled memory. If you don’t dispose of this object properly, memory won’t be returned to the pool, which will negatively affect performance.

See also

Understanding the Synergy JSON API

Examples

See Understanding the Synergy JSON API for a complete example.