ConfigureYearly

Configure the algorithm for an annual repetition of the events.

Syntax

Definition:

METHOD Configure : BOOL
    tTimeEvent : LTIME;
    nDay : UINT;
    eRecurrenceSpecification : E_ALY_RecurrenceSpecification;
    eDayOfWeek : E_ALY_DayOfWeek;
    nMonthOfYearMask : WORD;
VAR_INPUT
END_VAR

ConfigureYearly 1: Inputs

Name

Type

Description

tTimeEvent

LTIME

Time of the event

nDay

UINT

Day on which an event is to be created.

eRecurrenceSpecification

E_ALY_RecurrenceSpecification

Recurrence specification

Specific Day: The event should be created on a specific day. This can be set using the Day parameter.
First: The event should be created on the first specified day of the month. The specification is made via the Day Of Week parameter.
Last: The event should be created on the last specified day of the month. Specification takes place via the Day Of Week parameter

eDayOfWeek

E_ALY_DayOfWeek

Weekday of the event

Unspecified: The event is generated on the first or last day of the month, depending on the eRecurrenceSpecification parameter.
Monday..Sunday: The event is generated on the first or last set weekday of the month, depending on the eRecurrenceSpecification parameter.

nDayOfWeekMask

WORD

Bit mask for selecting the month on which the event is to be generated.

1: January

2: February

4: March

8: April

16: May

32: June

64: July

128: August

256: September

512: October

1024: November

2048: December

The enumeration E_ALY_MonthOfYearMask can be used. Multiple days can be combined with the operator OR.

ConfigureYearly 2: Return value

Name

Type

Description

ConfigureYearly

BOOL

Returns TRUE if successful.