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

DEPRECATED&colon; Use `setJsonFormat` instead&period;

== Synopsis

Declared in `&lt;ball&lowbar;recordjsonformatter&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
int
setFormat(std::string&lowbar;view const& format);
----

== Description

Set the message format specification (see &lcub;&grave;Record Format Specification&grave;&rcub;) of this record JSON formatter to the specified JSON&hyphen;syntax `format`&period; Return 0 on success, and a non&hyphen;zero value otherwise (if `format` is not valid JSON _or_ not a JSON conforming to the expected schema)&period;

== Return Value

0 on success, and a non&hyphen;zero value otherwise

== Parameters

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


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