addYear

addYear()

Overview

The addYear() function takes dateTimeValue and numberOfYears as arguments. It returns the dateTimeValue after adding the specified number of years to it.

The date-time value will be returned in the format specified in Application Settings.

Return Type

  • Date-Time

Syntax

<variable>=<dateTimeValue>.addYear(<numberOfYears>);

(OR)

<variable>=addYear(<dateTimeValue>, <numberOfYears>);
ParameterDescriptionData type
<variable>Variable which will contain the returned date-time value.NUMBER
<dateTimeValue>

The date-time value to which the specified number of years 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:

  • the hour value, or minute value, or second value, is specified in more than 2 digits.
  • the date value exceeds the number of days in that month.
  • an incorrect month value is specified.
  • the year value has more than 4 digits.

Refer this help document to learn about the supported date-time formats.

DATE-TIME
<numberOfYears>

The number of years to be added to dateTimeValue.

A negative number will subtract the specified number of years from dateTimeValue.

NUMBER

Examples

currentDate = '01-Jan-2019';
currentDateTime = '01-Jan-2019 15:00:00';
newDate = currentDate.addYear(100);                      // returns '01-Jan-2119 00:00:00'
newDateTime = currentDateTime.addYear(10);        // returns '01-Jan-2029 15:00:00'

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohodeluge.com