Differences

This shows you the differences between two versions of the page.

--- syntax:functions:isweekend [2019/05/22 22:25] – created dmitry
+++ syntax:functions:isweekend [2021/08/30 02:32] (current) – [Remarks] craigt
@@ Line 1: / Line 1: @@
-===== IsWeekend(date_as_number) =====
+====== IsWeekend(date) ======
+Category:  Date and Time function
-Returns TRUE if the date is Saturday or Sunday.
+\\
+=====Description=====
+This function returns TRUE if //date// falls on a weekend day (Saturday or Sunday).  Otherwise, it returns FALSE.
-^  Example  ^  Result  ^ Notes ^
+\\
-| isweekend(#2019-05-16)  |  FALSE  |Thursday |
+=====Arguments=====
-| isweekend(#2019-05-19)  |  TRUE   |Sunday   |
+^Argument^Type^Description^
+|date|Date or Number (date serial)|An expression representing a date.  The date to test whether it falls on a weekend day, or not.|
+**Return value type:** Boolean (TRUE/FALSE)
+\\
+=====Remarks=====
+The //date// argument can take any value or expression that evaluates to a date serial value.  Examples include:
+  * A date string:  #2019-12-12
+  * A date serial value: 43811 (the date serial for "2019-12-12")
+  * A date value created using any of the Date/Time functions that returns a date serial value.
+\\
+=====Examples=====
+  isweekend(#2019-05-16)  //Returns FALSE (Thursday)
+  isweekend(#2019-05-19)  //Returns TRUE (Sunday)
+\\
+=====See also=====
+  * [[syntax:functions:weekend|Weekend(date)]]