This documentation is archived and is not being maintained.

PersianCalendar::AddYears Method

Returns a DateTime object that is offset the specified number of years from the specified DateTime object.

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

public:
virtual DateTime AddYears(
	DateTime time, 
	int years
) override

Parameters

time
Type: System::DateTime
The DateTime to which to add years.
years
Type: System::Int32
The positive or negative number of years to add.

Return Value

Type: System::DateTime
The DateTime object that results from adding the specified number of years to the specified DateTime object.

ExceptionCondition
ArgumentException

The resulting DateTime is outside the supported range.

ArgumentOutOfRangeException

years is less than -10,000 or greater than 10,000.

The Kind property of the returned DateTime value always equals DateTimeKind::Unspecified. You can preserve the Kind property of the time parameter by calling the DateTime::SpecifyKind method, as the following example shows.

No code example is currently available or this language may not be supported.

The following code example demonstrates the use of the AddYears method.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, 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.
Show: