WriteStream( ) method (JsonConstruct)

Serializes the JsonConstruct (JsonObject or JsonArray) and any JsonConstructs it references to a statically defined output stream.. This is a recursive process resulting in a JSON representation of the entire set of JsonObjects and JsonArrays. On successful execution the method returns TRUE.

Return type: LOGICAL

Access: PUBLIC ABSTRACT

Applies to: Progress.Json.ObjectModel.JsonConstruct class

Syntax

WriteStream(INPUT stream AS CHARACTER)

WriteStream(INPUT stream AS CHARACTER,
            INPUT formatted AS LOGICAL)

WriteStream(INPUT stream AS CHARACTER,
            INPUT formatted AS LOGICAL,
            INPUT encoding AS CHARACTER)

stream

A CHARACTER expression that specifies the name of a stream to which the AVM writes the JSON string. If you specify the empty string (""), the AVM writes the JSON string to the default unnamed output stream. For WebSpeed, write the JSON string to the WebSpeed-defined output stream (WEBSTREAM).

For more information about using ABL unnamed output streams, see the DEFINE STREAM statement reference entry and the chapter on alternate I/O sources in OpenEdge Development: Programming Interfaces. For more information about using WebSeed-defined output streams, see OpenEdge Application Server: Developing WebSpeed Applications.

formatted

An LOGICAL expression where TRUE directs the AVM to format the JSON string in a hierarchical manner using extra white space, carriage returns, and line feeds. The default value is FALSE.

If you specify the Unknown value (?), the method uses the default value of FALSE.

encoding

A CHARACTER expression indicating the Unicode Transformation Format of the JSON string to be written. Valid values for UTF are "UTF-8", "UTF-16", "UTF-16BE", "UTF-16LE", "UTF-32", "UTF-32BE", and "UTF-32LE". If the value is the empty string (""), the Unknown value (?), or not given, the parameter defaults to "UTF-8". If the value is any other value, an error is raised.