Export (0) Print
Expand All

DateTimeOffset.AddYears Method

Adds a specified number of years to the DateTimeOffset object.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public Function AddYears ( _
	years As Integer _
) As DateTimeOffset

Parameters

years
Type: System.Int32
A number of years. The number can be negative or positive.

Return Value

Type: System.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.

ExceptionCondition
ArgumentOutOfRangeException

The resulting DateTimeOffset value is less than MinValue.

-or-

The resulting DateTimeOffset value is greater than MaxValue.

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.

NoteNote

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

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 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)


.NET Framework

Supported in: 4, 3.5 SP1, 3.0 SP1, 2.0 SP1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft