Differences

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

--- syntax:functions:addhours [2019/12/12 07:46] – dmitry
+++ syntax:functions:addhours [2021/08/29 18:07] – craigt
@@ Line 1: / Line 1: @@
-=====AddHours(number_date, number)=====
+====== AddHours(date, add_hours) ======
+Category:  Date and Time function
-Adds hours to the date. Subtracts if the number is negative.
+\\
+=====Description=====
+This function adds //add_hours// number of hours to //date//.  If //add_hours// is negative, the hours are subtracted.
-Example:
+\\
-^ Expression  ^ Result  ^ Notes  ^
+=====Arguments=====
-| addhours(#2019-12-12, 3)  |  43811.125 | Equivalent to 2019-Dec-12 03:00:00 |
+^Argument^Type^Description^
-| addhours(#2019-12-12, 0-3)  |  43810.875 | Equivalent to 2019-Dec-11 21:00:00  |
+|date|Date or Number (date serial)|A expression representing a date.  See "Remarks" below for details.|
+|add_hours |Number |The number of hours to be added to //date//, or subtracted if negative.|
-See also:
+**Return value type:** Number (date serial value).
+\\
+=====Remarks=====
+The //date// argument can take any value or expression that evaluates to a date serial value, with or without a time portion.  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 the [[syntax:functions:date|Date]] function: date("2019-12-12","yyyy-MM-dd").
+\\
+=====Examples=====
+  addhours(#2019-12-12, 3)  //Returns 43811.125 (Equivalent to 2019-Dec-12 03:00:00.)
+  addhours(43811, 6)  //Returns 43811.25 (Equivalent to 2019-Dec-12 06:00:00.)
+  addhours(#2019-12-12, -12)  //Returns 43810.5 (Equivalent to 2019-Dec-11 12:00:00; subtract hours.)
+  addhours(43811.5, 6)  //Returns 43811.75 (The source date includes a time portion.)
+  addhours( date("2019-12-12","yyyy-MM-dd") , 3)  //Returns 43811.125 (Using the date function.)
+\\
+===== See also =====
+  * [[syntax:functions:addmonths|AddMonths(date, add_months)]]
+  * [[syntax:functions:addyears|AddYears(date, add_years)]]
+  * [[https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx|MSDN: Custom Date and Time Format Strings]]
-* [[syntax:functions:addmonths|AddMonths(date_as_number, N)]]
-* [[syntax:functions:addyears|AddYears(number_date, number)]]