DateTimeOffset.AddYears(Int32) Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

DateTimeOffset.cs

Returns a new DateTimeOffset object that adds a specified number of years to the value of this instance.

public:
 DateTimeOffset AddYears(int years);

public DateTimeOffset AddYears (int years);

member this.AddYears : int -> DateTimeOffset

Public Function AddYears (years As Integer) As DateTimeOffset

Parameters

years

Int32

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

Returns

DateTimeOffset

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

Exceptions

ArgumentOutOfRangeException

The resulting DateTimeOffset value is less than DateTimeOffset.MinValue.

-or-

The resulting DateTimeOffset value is greater than DateTimeOffset.MaxValue.

Examples

In the United States, driver's licenses cannot be issued to persons under 16 years of age. The following example displays the latest possible date on which a person must be born in order to legally be issued a driver's license.

const int minimumAge = 16;
DateTimeOffset dateToday = DateTimeOffset.Now;
DateTimeOffset latestBirthday = dateToday.AddYears(-1 * minimumAge);
Console.WriteLine("To possess a driver's license, you must have been born on or before {0:d}.",
                  latestBirthday);

let minimumAge = 16
let dateToday = DateTimeOffset.Now
let latestBirthday = dateToday.AddYears(-1 * minimumAge)
printfn $"To possess a driver's license, you must have been born on or before {latestBirthday:d}."

Const minimumAge As Integer = 16
Dim dateToday As DateTimeOffset = DateTimeOffset.Now
Dim latestBirthday As DateTimeOffset = dateToday.AddYears(-1 * minimumAge)
Console.WriteLine("To possess a driver's license, you must have been born on or before {0:d}.", _
                  latestBirthday)

Remarks

Unlike most of the other methods that add a single time interval unit (such as minutes or days) to a date and time value, AddYears does not enable you to add fractional parts of a year. To add a time that consists of other time units in addition to years to a DateTimeOffset object, use the Add method.

Note

This method returns a new DateTimeOffset object. It does not modify the value of the current object by adding years to its date and time.