AddYears
Returns the UTC date and time for the year that is the number of years specified earlier than or later than the specified date and time.
Syntax
AddYears(numYears, baseDateTime)
Enabled for
| Search/Dashboard | Yes |
| Business Rules | Yes |
| Quick Actions | Yes |
| Workflow Objects | No |
| Reports | No |
Parameter
|
numYears |
The number of intervals. If not specified, uses the default interval which is 0. Can be either a positive integer, to indicate years in the future, or a negative integer, to indicate years in the past. |
| baseDateTime | (Optional) The base date for the function. If not specified, uses the default date which is the current date and time. |
Return Value
DateTime value in UTC time.
|
If the system has to display the return value, it implicitly converts it to text, thereby allowing the display format to change depending on your culture code. See Available Languages and Cultures for a list of the culture codes used by HEAT. |
Example
$(AddYears(3))
If today is April 10, 2014, this function returns the DateTime value for April 10, 2017.
$(AddYears(-1))
If today is April 10, 2014, this function returns the DateTime value for April 10, 2013.
$(AddYears(5, mydate))
If the value of mydate is April 10, 2014, this function returns the DateTime value for April 10, 2019 at the same time of day.