Aurora Multimedia WACI NX Jr., Reference Manual & Programming Manual

Page: 149 / 180

149
SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year, SetEventSchedule ( EventId, Recur, MaskOrDay, Month, Year,
RecurEveryN, Hour, Minute, Second ) RecurEveryN, Hour, Minute, Second ) RecurEveryN, Hour, Minute, Second ) RecurEveryN, Hour, Minute, Second )
Modify the schedule settings of a specified Event.
Syntax
HRESULT SetEventSchedule(
[in] long EventId,
[in] long Recur,
[in] long MaskOrDay,
[in] long Month,
[in] long Year,
[in] long RecurEveryN,
[in] long Hour,
[in] long Minute,
[in] long Second,
[out, retval] VARIANT_BOOL* Success
);
Parameters
EventId [in] ID of the Event to modify the schedule of.
Recur [in] The recurrence pattern used for this schedule. .
Recur value Description
0 Once
1 Daily
2 Weekly
3 Monthly
4 Yearly
MaskOrDay [in] Mask of days or specific day of the month.
MaskDay values for weekly Events:
Value Bit # Day
0x00000001 (1) 0 Sunday
0x00000002 (2) 1 Monday
0x00000004 (4) 2 Tuesday
0x00000008 (8) 3 Wednesday
0x00000010 (16) 4 Thursday
0x00000020 (32) 5 Friday
0x00000040 (64) 6 Saturday
Month [in] Month setting for the schedule. An integer between 1 and 12. This parameter is used only
for yearly schedules.
Year [in] Year setting for the schedule. An integer such as “1984” or “2001”