[#BloombergLP-bslfmt-basic_format_context]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::basic_format_context
:relfileprefix: ../../
:mrdocs:

A format context for use by `formatter::format()` partial specialization. It provides access to the output iterator for writing the formatted value and access to all formatting arguments.

== Synopsis

Declared in `<bslfmt_format_context.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_OUT,
    class t_CHAR>
class basic_format_context;
----

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_context/char_type.adoc[`char_type`] 
| This `typedef` is an alias for the character type `t_CHAR`.
| xref:BloombergLP/bslfmt/basic_format_context/formatter_type.adoc[`formatter_type`] 
| Alias for `bsl::formatter` specialized on `t_TYPE` and `t_CHAR`.
| xref:BloombergLP/bslfmt/basic_format_context/iterator.adoc[`iterator`] 
| This `typedef` is an alias for the output iterator type `t_OUT`.
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_context/advance_to.adoc[`advance_to`] 
| Update the contained iterator to that specified by `it`.
| xref:BloombergLP/bslfmt/basic_format_context/arg-02.adoc[`arg`] 
| Return a `basic_format_arg` type for the argument in the position specified by `id`, with indexing starting at zero. If `id` is not less than the number of contained arguments, a default‐constructed `basic_format_arg` object is returned.
| xref:BloombergLP/bslfmt/basic_format_context/out.adoc[`out`] 
| Return (by value) the contained output iterator. As this is returned by value, any changes will not be reflected in the contained iterator unless a subsequent call to `advance_to` is made.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/Format_ContextFactory.adoc[BloombergLP::bslfmt::Format_ContextFactory]`
| This class provides utility functions to enable manipulation of types declared by this component. It is solely for private use by other components of the `bslfmt` package and should not be used directly.
|===


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