Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt
hiddentrue

dateSet(date, dateField, dateValue) Sets an element of a date (e.g. the month) and returns the new date.

Function: dateSet()

Sets an element of a date (e.g. the month) , such as the day or month, and returns the new date.

Syntax

dateSet(date,dateField,dateValue)

...

Argument
Type
Parameter TypesDescription
dateDateThe original
date/time
date or date-time. For the current date-time use the attribute function now().
dateFieldSee Date
Field
-Time FunctionsThe
part
element of the date to be be changed
(e.g.
, for example the month or seconds
)
.
dateValue
Date Value
The new value for that date element

When updating the day of the week (e.g. to _SATURDAY), the result will be the date for that day of the week in the current week - and weeks being on Monday. See examples below.

.


Tip

Changing a date-time to a different _DAY_OF_WEEK, always returns a date in the same week as the input date. The week begins on Monday.  For example, if the input date is a Thursday, setting the day of the week to:

  • Monday, Tuesday or Wednesday returns an earlier date
  • Friday, Saturday or Sunday returns a later date.

Examples

ExampleReturns
dateSet("20100403.162359",_MONTH,3)Sets the month to 3, so returns the date/time "20100303.162359"
dateSet("in.invoiceDate",_MONTH,_JANUARY)

Returns in.invoiceDate with the month set to 1 (January)

...

. An invoice date of "20100303.162359"

...

becomes "20100103.162359"

dateSet("in.invoiceDate",_SECOND, 0)Returns in.invoiceDate with the seconds set to 0.

...

An invoice date-time of "20100303.162359"

...

becomes "20100303.162300".

Remember, when updating the day of the week, the resulting date will be that day of the week in the current week, and weeks begin on Monday. For example, if you use an input date which is a Thursday, setting the day of the week to Monday, Tuesday or Wednesday will give you an ealier date than the input; setting the day of the week to Friday, Saturday or Sunday will give you a later date than the input.

dateSet(toDate("20131205"),_DAY_OF_WEEK,_TUESDAY)The input date of "20131205" is a Thursday

...

.
This returns the date for the Tuesday in the same week, "20131203".
dateSet(toDate("20131205"),_DAY_OF_WEEK,_SATURDAY)The input date of "20131205" is a Thursday

...

.
This returns the date for the Saturday in the same week "20131207".

See Also

...


Excerpt
hiddentrue

dateSet(date, dateField, dateValue)   Sets an element of a date (e.g. the month) and returns the new date.