Newton Developer Technical Information: Newton Programmer's Guide: 2.1 OS Addendum /

Chapter 11 - Miscellaneous / Reference

Functions and Methods / Built-In Applications

SetEntryAlarm

calendar:SetEntryAlarm(mtgText,mtgStartDate,minutesOrDaysBefore)

Sets an alarm for the meeting or event with the given text at the given date and time. If the meeting or event is an instance of a repeating meeting or event, the alarm is set for all instances of the repeating meeting or event.

mtgText

A string or rich string that is the meeting text of the meeting or event for which you want to set the alarm time.

mtgStartDate

An integer specifying the start date and time of the meeting or event, in the number of minutes passed since midnight, January 1, 1904.

minutesBefore

A non-negative integer, which specifies how far in advance of the meeting or event the alarm should go off. A value of 0 means the alarm goes off at the time of the meeting. This integer should specify the number of minutes before mtgStartDate that you want the alarm to go off for a meeting, and the number of days before mtgStartDate for an event.

You can specify nil to clear an alarm that is currently set.

return value

Undefined; do not rely on it.

COMPATIBILITY

The version of this function available on Newton 2.0 OS can only be used for meetings. The kSetEventAlarmFunc function exists in the 2.0 platform file to set alarms for events.