Appendices > Macro Language > Built-in Functions > All Functions (Alphabetical)

bool = HolidayOfListOnDate(sHolList, nDate)

This macro function returns true if there is a holiday or one-time-date for the Holidays List sHolList on the date of nDate. Otherwise it return false. The allowed values for sHolList are : 'a', 'e', 'i', 'o', 'u'.

This function is useful if you only want to know that there is at least one holiday occurence on a given date (to change its color for example), but do not care what the holiday's name is.

Note that the code :

bIsHol = HolidayOfListOnDate('a', n_TokenDate)

is the same as

sCurHol = EvalToken(n_TokenDate, '[fa]')

bIsHol = (sCurHol <> '')

but using HolidayOfListOnDate is much faster and should always be used, if you do not need to know the details of a given day's holidays.