[#BloombergLP-bdlt-Formatter-format]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::xref:BloombergLP/bdlt/Formatter.adoc[Formatter]::format
:relfileprefix: ../../../
:mrdocs:

Write `value` formatted to `formatContext.out()`.

== Synopsis

Declared in `<bdlt_formatter.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_FORMAT_CONTEXT,
    class t_VALUE>
t_FORMAT_CONTEXT::iterator
format(
    t_VALUE const& value,
    t_FORMAT_CONTEXT& formatContext) const;
----

== Description

Write the output to `formatContext.out()` and return the output iterator after the output is done.

== Return Value

output iterator after writing

== Parameters

[cols="1,4"]
|===
| Name| Description
| *value*
| value to format
| *formatContext*
| format context providing the output iterator
|===


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