DateTimeOffset.AddYears Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Adds a specified number of years to the DateTimeOffset object.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Syntax
'Declaration
Public Function AddYears ( _
years As Integer _
) As DateTimeOffset
public DateTimeOffset AddYears(
int years
)
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.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | The resulting DateTimeOffset value is less than MinValue. -or- The resulting DateTimeOffset value is greater than MaxValue. |
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.
.gif "Note") Note: |
|---|
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. |
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 minimumAge As Integer = 16
Dim dateToday As DateTimeOffset = DateTimeOffset.Now
Dim latestBirthday As DateTimeOffset = dateToday.AddYears(-1 * minimumAge)
outputBlock.Text += String.Format("To possess a driver's license, you must have been born on or before {0:d}.", _
latestBirthday) + vbCrLf
const int minimumAge = 16;
DateTimeOffset dateToday = DateTimeOffset.Now;
DateTimeOffset latestBirthday = dateToday.AddYears(-1 * minimumAge);
outputBlock.Text += String.Format("To possess a driver's license, you must have been born on or before {0:d}.",
latestBirthday) + "\n";
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.