[#BloombergLP-baljsn-Encoder-encode-06]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/baljsn.adoc[baljsn]::xref:BloombergLP/baljsn/Encoder.adoc[Encoder]::encode
:relfileprefix: ../../../
:mrdocs:

Encode the specified `value`, of (template parameter) `TYPE`, in the JSON format using the specified `options` and output it onto the specified `streamBuf`. Specifying a nullptr `options` is equivalent to passing a default‐constructed EncoderOptions in `options`. `TYPE` shall be a `bdlat`‐compatible sequence, choice, or array type, or a `bdlat`‐compatible dynamic type referring to one of those types. Return 0 on success, and a non‐zero value otherwise.

== Synopsis

Declared in `<baljsn_encoder.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
int
encode(
    std::streambuf* streamBuf,
    TYPE const& value,
    xref:BloombergLP/baljsn/EncoderOptions.adoc[EncoderOptions] const& options);
----


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