add_years()

date_time xtd::date_time::add_years

(

int32

value

)

const

Returns a new xtd::date_time that adds the specified number of years to the value of this instance.

Parameters

value

A number of years. The value parameter can be negative or positive.

Returns

An object whose value is the sum of the date and time represented by this instance and the number of years represented by value.

Exceptions

xtd::argument_out_of_range_exception

The resulting xtd::date_time is less than xtd::date_time::min_value or greater than xtd::date_time::max_value.

Remarks

This method does not change the value of this xtd::date_time object. Instead, it returns a new xtd::date_time object whose value is the result of this operation.

The xtd::date_time::add_years method calculates the resulting year taking into account leap years. The month and time-of-day part of the resulting xtd::date_time object remains the same as this instance.

If the current instance represents the leap day in a leap year, the return value depends on the target date:

• If value + xtd::date_time::year() is also a leap year, the return value represents the leap day in that year. For example, if four years is added to February 29, 2012, the date returned is February 29, 2016.
• If value + xtd::date_time::year() is not a leap year, the return value represents the day before the leap day in that year. For example, if one year is added to February 29, 2012, the date returned is February 28, 2013.

Examples

The following example illustrates using the xtd::date_time::add_years method with a xtd::date_time value that represents a leap year day. It displays the date for the fifteen years prior to and the fifteen years that follow February 29, 2000.

Examples

date_time_day_of_year.cpp.