Reference > Expressions > Built-in Functions > Date Functions > AddWeeks

AddWeeks

Returns the UTC date and time for the week that is the number of weeks specified earlier than or later than the specified date and time.

Syntax

AddWeeks(numWeeks, baseDateTime)

Enabled for

Search/Dashboard Yes
Business Rules Yes
Quick Actions Yes
Workflow Objects No
Reports No

Parameter

numWeeks

The number of intervals. If not specified, uses the default interval which is 0. Can be either a positive integer, to indicate weeks in the future, or a negative integer, to indicate weeks 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

$(AddWeeks(1))

If today is April 10, 2014, this function returns the DateTime value for April 17, 2014.

 

$(AddWeeks(-1))

If today is April 10, 2014, this function returns the DateTime value for April 3, 2014.

 

$(AddWeeks(2, mydate))

If the value of mydate is April 10, 2014, this function returns the DateTime value for April 24, 2014 at the same time of day.