AlarmRecipient Property

This property contains the email address of the person to be alerted when this alarm is triggered.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetAlarmRecipient(int iAlarmIndex);
int SetAlarmRecipient(int iAlarmIndex, const char* lpszAlarmRecipient);

Unicode (Windows)
LPWSTR GetAlarmRecipient(INT iAlarmIndex);
INT SetAlarmRecipient(INT iAlarmIndex, LPCWSTR lpszAlarmRecipient);

- (NSString*)alarmRecipient:(int)alarmIndex;
- (void)setAlarmRecipient:(int)alarmIndex:(NSString*)newAlarmRecipient;

#define PID_CALDAV_ALARMRECIPIENT 7

IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_CalDAV_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_CalDAV_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_CalDAV_CheckIndex(void *lpObj, int propid, int arridx);

Default Value

""

Remarks

This property contains the email address of the person to be alerted when this alarm is triggered. If AlarmAction is set to aEmail this property must contain one or more comma-separated email addresses to which the email alarm is to be sent. For instance:

  CalDAV.Alarm.Action = aEmail;
  CalDAV.Alarm.Recipient = "mailto:john_doe@example.com";
  CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST).";
  CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting.";

The AlarmIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String