[#BloombergLP-bslfmt-basic_format_context]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::basic&lowbar;format&lowbar;context
:relfileprefix: ../../
:mrdocs:

A format context for use by `formatter&colon;&colon;format()` partial specialization&period;

== Synopsis

Declared in `&lt;bslfmt&lowbar;format&lowbar;context&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;
    class t&lowbar;OUT,
    class t&lowbar;CHAR&gt;
class basic&lowbar;format&lowbar;context;
----

== Description

It provides access to the output iterator for writing the formatted value and access to all formatting arguments&period;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_context/char_type.adoc[`char&lowbar;type`] 
| This `typedef` is an alias for the character type `t&lowbar;CHAR`&period;
| xref:BloombergLP/bslfmt/basic_format_context/formatter_type.adoc[`formatter&lowbar;type`] 
| Alias for `bsl&colon;&colon;formatter` specialized on `t&lowbar;TYPE` and `t&lowbar;CHAR`&period;
| xref:BloombergLP/bslfmt/basic_format_context/iterator.adoc[`iterator`] 
| This `typedef` is an alias for the output iterator type `t&lowbar;OUT`&period;
|===


== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_context/advance_to.adoc[`advance&lowbar;to`] 
| Update the contained iterator to that specified by `it`&period;
| xref:BloombergLP/bslfmt/basic_format_context/arg-02.adoc[`arg`] 
| Return the formatting argument at zero&hyphen;based index `id`&period;
| xref:BloombergLP/bslfmt/basic_format_context/out.adoc[`out`] 
| Return (by value) the contained output iterator&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/Format_ContextFactory.adoc[BloombergLP::bslfmt::Format&lowbar;ContextFactory]`
| Utility factory for constructing `basic&lowbar;format&lowbar;context` objects&period;
|===


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