[#BloombergLP-bdlb-Guid_BslFmtFormatterImpl-parse]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlb.adoc[bdlb]::xref:BloombergLP/bdlb/Guid_BslFmtFormatterImpl.adoc[Guid&lowbar;BslFmtFormatterImpl]::parse
:relfileprefix: ../../../
:mrdocs:

Parse the format specification in `parseContext`&period;

== Synopsis

Declared in `&lt;bdlb&lowbar;guidformatter&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class t&lowbar;PARSE&lowbar;CONTEXT&gt;
constexpr
t&lowbar;PARSE&lowbar;CONTEXT::iterator
parse(t&lowbar;PARSE&lowbar;CONTEXT& parseContext);
----

== Description

Parse the format specification contained in the specified `parseContext` and return an iterator, pointing to the beginning of the unparsed section of the format string&period; Throw a `bsl&colon;&colon;format&lowbar;error` exception if the specification does not conform to the grammar documented at the top of this component&period;

== Return Value

iterator to the unparsed remainder of the format string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *parseContext*
| parse context holding the format specification
|===


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