WeekDay Function

This function returns the number corresponding to the weekday represented by a serial date number that is generated by the DateSerial or the DateValue functions.

This help page describes the WeekDay function used in Basic scripts. If you are interested in the WeekDay function used in Collabora Office Calc, refer to this help page.

Syntax:


  WeekDay (SerialDate, [FirstDayOfWeek])

Parameters:

SerialDate: Integer expression that contains the serial date number that is used to calculate the day of the week.

FirstDayOfWeek: Integer value indicating which weekday should be considered as the first day of the week. The default value is 0, meaning that the system locale settings are used to determine the first day of the week.

The parameter FirstDayOfWeek accepts values ranging from 0 to 7. The table below describes the meaning of each possible value:

Value	VBA Constant	Description
0	vbUseSystemDayOfWeek	Use system locale settings
1	vbSunday	Sunday (default)
2	vbMonday	Monday
3	vbTuesday	Tuesday
4	vbWednesday	Wednesday
5	vbThursday	Thursday
6	vbFriday	Friday
7	vbSaturday	Saturday

The VBA constants listed above are only available if VBA support has been enabled. For more information, read the VBASupport Statement help page.

Return value:

Integer

Error codes:

5 Invalid procedure call

Example:

The following example uses the function Now() to determine the current weekday.


Sub ExampleWeekDay
    Dim sDay As String
    ' Return And display the day of the week
    Select Case WeekDay( Now )
            Case 1: sDay="Sunday"
            Case 2: sDay="Monday"
            Case 3: sDay="Tuesday"
            Case 4: sDay="Wednesday"
            Case 5: sDay="Thursday"
            Case 6: sDay="Friday"
            Case 7: sDay="Saturday"
    End Select
    MsgBox "" + sDay,64,"Today Is"
End Sub

The following example illustrates the use FirstDayOfWeek parameter, assuming that Tuesday is the first day of the week.


  Dim someDay As Long
  ' The date January 1st 2021 was a Friday
  someDay = DateSerial(2021, 01, 01)
  ' Prints "6" assuming Sunday is the first day of the week
  MsgBox WeekDay(someDay)
  ' Prints "4" assuming Tuesday is the first day of the week
  MsgBox WeekDay(someDay, 3)