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

This `struct` provides a namespace for enumerating month‐of‐year values. See `Enum` in the TYPES sub‐section for details.

== Synopsis

Declared in `<bdlt_monthofyear.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
struct MonthOfYear;
----

== Description

This `struct`: * supports a complete set of _enumeration_ operations For terminology see `bsldoc_glossary`.

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/MonthOfYear/Month.adoc[`Month`] 
| Define an alias, `Month`, to the enum type, `Enum` defined by this component.
|===


== Enums

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/MonthOfYear/_04enum.adoc[`Unnamed enum`] 
| Define `k_NUM_MONTHS` to be the number of consecutively valued enumerators in the range `[ e_JAN .. e_DEC ]`.
| xref:BloombergLP/bdlt/MonthOfYear/Enum.adoc[`Enum`] 
| Define the list of month‐of‐year values.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlt/MonthOfYear/bdexStreamIn.adoc[`bdexStreamIn`] 
| Assign to `variable` the value read from `stream` using the BDEX protocol.
| xref:BloombergLP/bdlt/MonthOfYear/bdexStreamOut.adoc[`bdexStreamOut`] 
| Write `value` to `stream` using the specified BDEX `version` format.
| xref:BloombergLP/bdlt/MonthOfYear/maxSupportedBdexVersion-0b.adoc[`maxSupportedBdexVersion`] 
| `maxSupportedBdexVersion` overloads
| xref:BloombergLP/bdlt/MonthOfYear/print.adoc[`print`] 
| Write the string representation of the specified enumeration `value` to the specified output `stream`.
| xref:BloombergLP/bdlt/MonthOfYear/toAscii.adoc[`toAscii`] 
| Return the string representation of the specified enumeration `value`.
|===



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