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

Type that wraps a `basic&lowbar;string&lowbar;view` for use by formatting function&period; The constructor performs additional compile&hyphen;time checks of the format string provided (not yet implemented)&period;

== Synopsis

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

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bslfmt/basic_format_string/2constructor.adoc[`basic&lowbar;format&lowbar;string`]         [.small]#[constructor]#
| Create an instance of this type from the specified `str`&period; This function only takes part in overload resolution if `str` is convertible to a `basic&lowbar;string&lowbar;view`&period; Construction is ill&hyphen;formed if `str` is not a compile&hyphen;time constant&period;
| xref:BloombergLP/bslfmt/basic_format_string/get.adoc[`get`] 
| Return the wrapped `basic&lowbar;string&lowbar;view` contained by this instance&period;
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bslfmt/Format_String_TestUpdater.adoc[BloombergLP::bslfmt::Format&lowbar;String&lowbar;TestUpdater]`
| This is a component&hyphen;private type which enables test drivers to work around the compile&hyphen;time restrictions in `basic&lowbar;format&lowbar;string` construction&period;
|===


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