{{tag>Function Function_List Date_And_Time}}
====== IS_RECURRING_DATE ======
===== Description =====
Checks whether a date falls on one of the dates of a recurring calendar appointment. The appointment is an object in the Context that belongs to the Appointments group (see [[:2500_config_apps:2700_appoint_objects|Adding Appointment Objects]]) and owns the recurrence; its recurrence rule, exception dates and start time decide which dates match.
===== Syntax =====

''IS_RECURRING_DATE (date, object)''

Cannot be used in the condition of a [[:ref:a_f:a:find|FIND]] action.

===== Parameters =====
  - The date to check: an attribute of the Date type, a date constant or a calculation producing a date
  - The name of the object in the Context that owns the recurrence, written as a string constant (for example ''%%'%%Task%%'%%''); it must be a member of the Appointments group
===== Returns =====

**Yes/No**: ''Yes'' if the date is one of the dates of the recurrence (exception dates excluded), otherwise ''No''. It is also ''No'' when there is no such object in the Context, or when the object has no recurrence or no start time.

===== Example =====
<code aim>IF IS_RECURRING_DATE (CURRENT_DATE, 'Task') = 'Yes' THEN SomeObject.SomeAttribute = 20 </code>

===== Related =====

[[ref:a_f:f:af:current_date|CURRENT_DATE]], [[ref:a_f:f:af:day_of_week|DAY_OF_WEEK]], [[ref:a_f:f:af:next_day_of_week|NEXT_DAY_OF_WEEK]], [[ref:a_f:f:af:date_add|DATE_ADD]]