addMonth()
Table of Contents
Overview
The addMonth() function takes dateTimeValue and numberOfMonths as arguments. It returns the dateTimeValue after adding the specified number of months to it.
The date-time value will be returned in the format specified in Application Settings.
Return Type
- Date-Time
Syntax
(OR)
Parameter | Description | Data type |
---|---|---|
<variable> | Variable which will contain the returned date-time value. | NUMBER |
<dateTimeValue> | The date-time value to which the specified number of months will be added. The date-time value can be specified without a time value, in which case 00:00:00 will be taken as the default time value. If the hour value is specified as 24 or more, the date-time value be reset to 00:00:00. If the minutes value is specified as 60 or more, the mm:ss value will be reset to 00:00, if the seconds value is specified as 60 or more, the ss value will be reset to 00. A runtime error will be encountered if:
Refer this help document to learn about the supported date-time formats. | DATE-TIME |
<numberOfMonths> | The number of months to be added to dateTimeValue. . A negative number will subtract the specified number of months from dateTimeValue. | NUMBER |
Examples
currentDateTime = '01-Jan-2019 15:00:00';
newDate = currentDate.addMonth(11); // returns '01-Dec-2019 00:00:00'
newDateTime = currentDateTime.addMonth(13); // returns '01-Feb-2020 15:00:00'