[#BloombergLP-bdljsn-StringUtil-readString-01]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdljsn.adoc[bdljsn]::xref:BloombergLP/bdljsn/StringUtil.adoc[StringUtil]::readString
:relfileprefix: ../../../
:mrdocs:

Load into `value` the UTF‐8 equivalent of the JSON `string`.

== Synopsis

Declared in `<bdljsn_stringutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
readString(
    std::pmr::string* value,
    std::string_view const& string,
    int flags = e_NONE);
----

== Description

Load to the specified `value` the UTF‐8 codepoint sequence equivalent to the specified (JSON) `string` (see []Strings)). Return 0 on success and a non‐zero value otherwise. Optionally specify `flags` to request variances from certain rules of JSON decoding (see ).

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *value*
| receives the decoded UTF‐8 string
| *string*
| JSON string to decode (including quotes)
| *flags*
| optional decoding variance flags
|===


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