AlarmAction Property

This property determines what the CalDAV server will do when the alarm Trigger is reached.

Syntax

int GetAlarmAction(int iAlarmIndex);

int SetAlarmAction(int iAlarmIndex, int iAlarmAction);

Possible Values

  A_NO_ALARM(0), 
  A_AUDIO(1), 
  A_DISPLAY(2), 
  A_EMAIL(3)

Default Value

Remarks

This property determines what the CalDAV server will do when the alarm AlarmTrigger is reached. The following table explains the possible alarm actions:


aAudio (0)	Specifies an alarm that causes a sound to be played to alert the user. You may attach a custom sound file using the AlarmAttachment property.
aDisplay (1)	Specifies an alarm that causes a visual alert to be displayed to the user. If AlarmAction is set to this value, you must also set the AlarmMessage property with the message to be displayed.
aEmail (2)	Instructs the CalDAV sever to email a specified AlarmRecipient. In this case, the AlarmMessage property will contain the message body of the email and the AlarmSubject property should contain the subject line.

The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

Integer