[#BloombergLP-ball-RecordJsonFormatter-setJsonFormat]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/ball.adoc[ball]::xref:BloombergLP/ball/RecordJsonFormatter.adoc[RecordJsonFormatter]::setJsonFormat
:relfileprefix: ../../../
:mrdocs:

Set this formatter's JSON message format specification to `format`.

== Synopsis

Declared in `<ball_recordjsonformatter.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
setJsonFormat(std::string_view const& format);
----

== Description

Set the message format specification (see {`Record Format Specification`}) of this record JSON formatter to the specified JSON‐syntax `format`. Return 0 on success, and a non‐zero value otherwise (if `format` is not valid JSON _or_ not a JSON conforming to the expected schema). Note that this is the method used by the `json://` scheme.

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *format*
| JSON‐syntax format specification
|===


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