Differences

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

--- syntax:functions:addmonths [2015/04/03 20:48] – elenap
+++ syntax:functions:addmonths [2021/08/29 18:20] – craigt
@@ Line 1: / Line 1: @@
-===== AddMonths(date_as_number, N) =====
+====== AddMonths(date, add_months) ======
+Category:  Date and Time function
-Adds //N// months to a date represented as number. //N// can be in range from -10000 to 10000.
+\\
+=====Description=====
+This function adds //add_months// number of months to //date//.  If //add_months// is negative, the months are subtracted.
-^  Example  ^  Result  ^  Notes  ^
+\\
-| addmonths(42097, 3)  |  42188  |  42097 corrensponds to April 4th, 2015  |
+=====Arguments=====
-| addmonths(42097, 0-3)  |  42007  |  42097 corrensponds to April 4th, 2015  |
+^Argument^Type^Description^
+|date|Date or Number (date serial)|A expression representing a date.  See "Remarks" below for details.|
+|add_months |Number |The number of months to be added to //date//, or subtracted if negative.|
-Note: keep in mind that EasyMorph doesn't support unary minus in expressions - see Example 2 above.
+**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=====
+  addmonths(#2019-12-12, 2)  //Returns 43873 (Equivalent to 2020-Feb-12.)
+  addmonths(43811, 5)  //Returns 43963 (Equivalent to 2020-May-12.)
+  addmonths(#2019-12-12, -2)  //Returns 43720 (Equivalent to 2019-Oct-12; subtract months.)
+\\
+===== See also =====
+  * [[syntax:functions:addhours|AddHours(date, add_hours)]]
+  * [[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]]