DateAddYear

See Also: Time and Date Functions

Purpose

The DateAddYear function adds or subtracts a given number of years to a given DateTime variable dtVar.

If the added unit exceeds the range of a DateTime section, the entire DateTime is adjusted. For example, adding 48 to hours would add 2 days to the DateTime variable. The returned DateTime variable is always valid.

The DateTime variable passed to the function must be valid and non-null. If this is not the case, a DFERR_INVALID_DATETIME error will be raised. You can use the IsDateValid and IsNullDateTime functions to ensure the value you are passing to this function is valid.

This differs from the DateSetXxx functions, which do not perform date arithmetic (i.e., they just set one DateTime section) and neither the incoming nor outgoing DateTime variable is tested for validity.

This is part of a family of DateTime manipulation functions which includes: - DateAddDay - DateAddHour - DateAddMillisecond - DateAddMinute - DateAddMonth - DateAddSecond - DateAddYear

The DateSet and CurrentDateTime functions can be used to initialize a DateTime value.

Return Type

DateTime

Syntax

Use GlobalDateTimeFunctions.pkg
DateAddYear({dtVar}, {iYearsToAdd})

Where: - {dtVar} is a value of type DateTime. - {iYearsToAdd} is an integer value representing the number of years to add to or subtract from dtVar.

Example

This example sets the date of a DateTime variable and then adds 1 year to the time.

Procedure Test
    DateTime dtVar
    Move (DateSet(2015, 9, 26)) to dtVar
    Move (DateAddYear(dtVar, 1)) to dtVar
    // This will print (using US date settings):
    // 9/26/2016 12:00:00 AM
    Showln dtVar
End_Procedure

This example sets the date of a DateTime variable and then subtracts 1 year from the time.

Procedure Test
    DateTime dtVar
    Move (DateSet(2015, 9, 26)) to dtVar
    Move (DateAddYear(dtVar, -1)) to dtVar
    // This will print (using US date settings):
    // 9/26/2014 12:00:00 AM
    Showln dtVar
End_Procedure

DateAddXxx Functions vs. DateSetXxx

The DateAddXxx functions differ from the DateSetXxx functions, which do not perform date arithmetic (i.e., they just set one DateTime section) and neither the incoming nor outgoing DateTime variable is tested for validity.

In most cases, the DateSet function and the DateAddXxx functions (DateAddDay, DateAddHour, DateAddMillisecond, DateAddMinute, DateAddMonth, DateAddSecond, DateAddYear) can be used in preference to the DateSetXxx functions (DateSetDay, DateSetHour, DateSetMillisecond, DateSetMinute, DateSetMonth, DateSetSecond, DateSetYear). The DateSetXxx functions are lower level and should be rarely used.