Modifying Action Diagrams › Understanding Built-In Functions › Selection Parameters for Date Built-In Functions › Date Increment

Date Increment

The *DATE INCREMENT built-in function lets you add a quantity to a given date. You specify the kind of quantity to add using the *Duration type parameter. Note that you should check the return code set by this function in order to catch any errors encountered. This function is the converse of the *DURATION function.

The *DATE INCREMENT built-in function performs the operation:

*Date1 = *Date2 + *Duration

There are eight parameters for this function type:

• Seven input parameters
  • *Date2 specifies the beginning date. If it is of type NBR, it is interpreted as the number of days since January 1, 1801 (day one).
  • *Duration specifies the quantity to be added to the beginning date. Its meaning is determined by the value of *Duration type.
  • *Duration type specifies the meaning of the quantity to be added to the beginning date. See the table at the end of this topic.
  • *Excluded days of week specify days that are normally not to be included in the sum.
  • *Date List name specifies the name of an existing date list. Date lists let you override selection rules set by the *Excluded days of week parameter for particular dates. The specified date list needs to be in the *Date Lists array when the built-in function executes.
  • *Date list autoload determines whether the function is to automatically load the specified date list into the *Date Lists array when the function is executed.
  • *Select days/dates lets you reverse the date selection determined by the *Date List name and *Excluded days of week parameters. The default is to select included dates.
• One output parameter, *Date1, which specifies the result date. If it is of type NBR, it is interpreted as the number of days since January 1, 1801 (day one).

For more information on the selection input parameters briefly described here, see the Selection Parameters for Date Built-In Functions topic in the *DATE DETAILS built-in function description.

The possible values for *Duration type and the effect each has on the meaning of the *Duration parameter are shown in the following table.