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

This `class` provides a specifier formatter for printing `Datetime` objects.

== Synopsis

Declared in `<bdlt_datetimeformatter.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/DatetimeFormatter/2constructor.adoc[`DatetimeFormatter`]         [.small]#[constructor]#
| Create an object in its default initial state.
| xref:BloombergLP/bdlt/DatetimeFormatter/extraSections.adoc[`extraSections`] 
| Return the `bslfmt::FormatSpecificationParser::Sections` flags that apply to this value type.
| xref:BloombergLP/bdlt/DatetimeFormatter/formatDefault.adoc[`formatDefault`] 
| Format the specified `value` to the specified `out` using the default format and return `out`.
| xref:BloombergLP/bdlt/DatetimeFormatter/formatIso8601.adoc[`formatIso8601`] 
| Format the specified `value` to the specified `out` using the Iso8601 format and return `out`.
| xref:BloombergLP/bdlt/DatetimeFormatter/formatNextSpecifier.adoc[`formatNextSpecifier`] 
| If the first character of the specified `*specInOut` is recognized by this specifier formatter, use it to format the specified `value` to `*outIt`, remove the character from `*specInOut`, and return `true`, otherwise return `false` with no modification to `*specInOut`.
| xref:BloombergLP/bdlt/DatetimeFormatter/parseDefault.adoc[`parseDefault`] 
| Parse a date time that will be formatted in default mode.
| xref:BloombergLP/bdlt/DatetimeFormatter/parseIso8601.adoc[`parseIso8601`] 
| Parse a date time that will be formatted in Iso8601 mode.
| xref:BloombergLP/bdlt/DatetimeFormatter/parseNextModifier.adoc[`parseNextModifier`] 
| Examine the first character of the specified `*specInOut` and if it is recognized as a modifier by this object, update this object's state to reflect it and pop it off the front of `*specInOut` and return `true`, and if not, return `false` with no modification to `*specInOut`.
| xref:BloombergLP/bdlt/DatetimeFormatter/parseNextSpecifier.adoc[`parseNextSpecifier`] 
| If the first character of the specified `*specInOut` is recognized by this specifier formatter, parse it, remove it from `*specInOut`, and return `true`, otherwise return `false` with no modification to `*specInOut`. The behavior is undefined if `*specInOut` is empty.
| xref:BloombergLP/bdlt/DatetimeFormatter/postprocess.adoc[`postprocess`] 
| Read post‐processed fields from the specified `spec` that are relevant to this specifier formatter.
| xref:BloombergLP/bdlt/DatetimeFormatter/totalWidth.adoc[`totalWidth`] 
| Return the anticipated width of output given all the `parse*` calls that have been happened thus far and the specified `value`.
|===



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