caladdhours() Function

Function

caladdhours( start_datetime, number, calendar_name )

This function adds a given number of hours to a Date and Time plus any non-working hours (as designated on the process calendar) and returns the resulting Date and Time.

Parameters

Keyword Type Description

start\_datetime

Date and Time

The starting Date and Time.

number

Integer

The number of net work hours to be added to the starting Date and Time.

calendar\_name

Text

This optional parameter accepts the name of a system calendar; otherwise, the default calendar is used.

Returns

Date and Time

Usage considerations

The function only returns Date and Time values that fall within the working time defined in the process calendar.

It correctly calculates results across daylight saving time boundaries.

If the start_datetime value is a non-working time, adding 0 hours returns the same Date and Time given as the start_datetime; adding 1 or more hours returns the next working time plus that many work hours.

Passing a calendar name allows you to calculate working hours using an alternate system calendar, if you have multiple calendars configured.

See also: Process Calendar Settings

Examples

You can experiment with this function in the test box below.

Test Input

caladdhours(datetime(2011,12,13,12,0,0),12) returns 12/14/2011 4:00 PM GMT +00:00

Open in Github Built: Fri, Oct 15, 2021 (09:55:45 AM)

On This Page

FEEDBACK