[#BloombergLP-bblb-ScheduleGenerationUtil-generateFromDayOfWeekInMonth-0c]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bblb.adoc[bblb]::xref:BloombergLP/bblb/ScheduleGenerationUtil.adoc[ScheduleGenerationUtil]::generateFromDayOfWeekInMonth
:relfileprefix: ../../../
:mrdocs:

Load day‐of‐week‐in‐month schedule dates into the specified `schedule`.

== Synopsis

Declared in `<bblb_schedulegenerationutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
void
generateFromDayOfWeekInMonth(
    xref:bsl/vector-00d.adoc[bsl::vector<bdlt::Date>]* schedule,
    xref:BloombergLP/bdlt/Date.adoc[bdlt::Date] const& earliest,
    xref:BloombergLP/bdlt/Date.adoc[bdlt::Date] const& latest,
    int exampleYear,
    int exampleMonth,
    int intervalInMonths,
    xref:BloombergLP/bdlt/DayOfWeek/Enum.adoc[bdlt::DayOfWeek::Enum] dayOfWeek,
    int occurrenceWeek);
----

== Description

Load, into the specified `schedule`, the chronologically increasing sequence of unique dates that are on the specified `dayOfWeek` of the specified `occurrenceWeek` of the month, integral multiples of the specified `intervalInMonths` away from the specified `exampleYear` and `exampleMonth`, and within the specified closed‐interval `[earliest, latest]`. The behavior is undefined unless `earliest <= latest`, `1 <= exampleYear <= 9999`, `1 <= exampleMonth <= 12`, `1 <= intervalInMonths`, and `1 <= occurrenceWeek <= 4`.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *schedule*
| receives the generated date sequence
| *earliest*
| inclusive start of the date window
| *latest*
| inclusive end of the date window
| *exampleYear*
| reference year for the interval lattice
| *exampleMonth*
| reference month for the interval lattice
| *intervalInMonths*
| spacing between schedule months
| *dayOfWeek*
| weekday required in `occurrenceWeek`
| *occurrenceWeek*
| week‐of‐month index in the range `[1 .. 4]`
|===


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