[#BloombergLP-bdljsn-JsonUtil-read-07]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdljsn.adoc[bdljsn]::xref:BloombergLP/bdljsn/JsonUtil.adoc[JsonUtil]::read
:relfileprefix: ../../../
:mrdocs:

Load a value‐semantic representation of JSON text into `result`.

== Synopsis

Declared in `<bdljsn_jsonutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
read(
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    xref:BloombergLP/bdljsn/Error.adoc[Error]* errorDescription,
    std::istream& input,
    xref:BloombergLP/bdljsn/ReadOptions.adoc[ReadOptions] const& options);
----

== Description

Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *result*
| object to receive the parsed JSON
| *errorDescription*
| receives a description if parsing fails
| *input*
| stream supplying JSON text
| *options*
| options controlling JSON parsing
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#