If you would like to upgrade to a newer long-term support version of Studio Pro, see Moving from Mendix Studio Pro 8 to 9.
Between Date Function Calls
Introduction
Between date function calls calculate the differences between two dates.
For a deep-dive look into working with DateTime functions, check out this video:
millisecondsBetween
The millisecondsBetween function calculates the difference between the input values in milliseconds.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
| The difference between the two dates measured in milliseconds | Decimal |
Example
If you use the following input:
millisecondsBetween(dateTime(2007, 1, 1, 1, 1, 1), dateTime(2007,1,1,1,1,3))
The output is:
2000
secondsBetween
The secondsBetween function calculates the difference between the input values in seconds.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
| The difference between the two dates measured in seconds. | Decimal |
Example
If you use the following input:
secondsBetween(dateTime(2007, 1, 1, 1, 1, 1), dateTime(2007,1,1,1,2,3))
The output is:
62
minutesBetween
The minutesBetween function calculates the difference between the input values in minutes.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
| The difference between the two dates measured in minutes. | Decimal |
Example
If you use the following input:
minutesBetween(dateTime(2007, 1, 1, 1, 2, 1), dateTime(2007,1,1,1,1,1))
The output is:
1
hoursBetween
The hoursBetween function calculates the difference between the input values in hours.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
| The difference between the two dates measured in hours. | Decimal |
Example
If you use the following input:
hoursBetween(dateTime(2007, 1, 1, 3, 31, 1), dateTime(2007,1,1,1,1,1))
The output is:
2.5
daysBetween
The daysBetween function calculates the difference between the input values in days.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
The difference between the two dates as a positive Decimal measured in days. Time is taken into consideration, so comparing date-x 0:00 with date-x 06:00 will result in 0.25000000. |
Positive decimal |
Example
If you use the following input:
daysBetween(dateTime(2007, 2, 13, 1, 1, 1), dateTime(2007,1,1,1,1,1))
The output is:
43
weeksBetween
The weeksBetween function calculates the difference between the input values in weeks.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
| The difference between the two dates measured in weeks. | Decimal |
Example
If you use the following input:
weeksBetween(dateTime(2007, 1, 9, 1, 1, 1), dateTime(2007,1,1,1,1,1))
The output results in 8 days divided by 7 days in a week:
1.1428571428571428
calendarMonthsBetween
The calendarMonthsBetween function calculates the difference between the input values in months. Time will be ignored. The dates are assumed to be in the end-user’s local time zone.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
| The difference between the two dates measured in months. | Integer/Long |
Example
If you use the following input:
calendarMonthsBetween(dateTime(2007, 1, 1, 10, 1, 1), dateTime(2007, 8, 1, 1, 1, 1))
The output results in the amount of months between the two dates:
7
calendarYearsBetween
The calendarYearsBetween function calculates the difference between the input values in years. Time will be ignored. The dates are assumed to be in the end-user’s local time zone.
Input Parameters
The input parameters are described in the table below:
| Value | Type |
|---|---|
| First date | Date and time |
| Second date | Date and time |
Output
The output is described in the table below:
| Value | Type |
|---|---|
| The difference between the two dates measured in years. | Integer/Long |
Example
If you use the following input:
calendarYearsBetween(dateTime(2007, 1, 1, 10, 1, 1), dateTime(2017, 1, 1, 1, 1, 1))
The output results in the amount of years between the two dates:
10