WriteFile( ) method (JsonConstruct)

Serializes the JsonConstruct (JsonObject or JsonArray) and any JsonConstructs it references to an output file. 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 

WriteFile( INPUT file-name AS CHARACTER )   WriteFile( INPUT file-name AS CHARACTER,            INPUT formatted AS LOGICAL )   WriteFile( INPUT file-name AS CHARACTER,            INPUT formatted AS LOGICAL,            INPUT encoding AS CHARACTER )

file-name

A CHARACTER expression that specifies the name of a file to which the AVM writes the JSON string. You can specify an absolute pathname or a pathname relative to the current working directory. If a file with the specified name already exists, the AVM verifies that the file is writeable and overwrites the file.

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.