AlarmSubject Property

This property contains the subject of the message used to alert the user when this alarm is triggered.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetAlarmSubject(int iAlarmIndex);
int SetAlarmSubject(int iAlarmIndex, const char* lpszAlarmSubject);

Unicode (Windows)
LPWSTR GetAlarmSubject(INT iAlarmIndex);
INT SetAlarmSubject(INT iAlarmIndex, LPCWSTR lpszAlarmSubject);

- (NSString*)alarmSubject:(int)alarmIndex;
- (void)setAlarmSubject:(int)alarmIndex:(NSString*)newAlarmSubject;

#define PID_CALDAV_ALARMSUBJECT 9

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 subject of the message used to alert the user when this alarm is triggered. If AlarmAction is set to aEmail this property will contain the subject the email that is sent to the AlarmRecipient. 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