[#BloombergLP-bdlt-Calendar-isWeekendDay-03]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::xref:BloombergLP/bdlt/Calendar.adoc[Calendar]::isWeekendDay
:relfileprefix: ../../../
:mrdocs:

Return `true` if `dayOfWeek` is a weekend day in this calendar.

== Synopsis

Declared in `<bdlt_calendar.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
isWeekendDay(xref:BloombergLP/bdlt/DayOfWeek/Enum.adoc[DayOfWeek::Enum] dayOfWeek) const;
----

== Description

Return `true` if the specified `dayOfWeek` is a weekend day in this calendar, and `false` otherwise. The behavior is undefined unless no weekend‐days transitions were added to this calendar via the `addWeekendDaysTransition` method.

== Return Value

`true` if `dayOfWeek` is a weekend day, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *dayOfWeek*
| day of the week to test
|===


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