CAlarmIface Class Reference

This is a pure Abstract class. More...

#include <CAlarmIface.h>

Inheritance diagram for CAlarmIface:

Public Member Functions
virtual long	addAlarmEvent (time_t event_time, string message, string location, time_t dateStart, time_t dateEnd, string compId, int iCalendarId, string szDescription, int iType, bool allday, string szZone, int &pErrorCode)=0
virtual int	deleteAlarmEvent (long cookie, int &pErrorCode)=0
virtual long	modifyAlarmEvent (long oldcookie, time_t modify_time, string message, string location, time_t dateStart, time_t dateEnd, string sCompId, int iCalendarId, string szDescription, int iType, bool allday, string szZone, int &pErrorCode)=0

---

Detailed Description

This is a pure Abstract class.

CAlarmIface class

---

Member Function Documentation

virtual long CAlarmIface::addAlarmEvent	(	time_t	event_time,
		string	message,
		string	location,
		time_t	dateStart,
		time_t	dateEnd,
		string	compId,
		int	iCalendarId,
		string	szDescription,
		int	iType,
		bool	allday,
		string	szZone,
		int &	pErrorCode
	)			[pure virtual]

addAlarmEvent Function to add the alarm event

Parameters:

	event_time	Event time in time_t format
	message	Event summary displays in alarm message
	location	Event location displays in alarm message
	dateStart	Event start date
	dateEnd	Event end date
	compId	component Id
	iCalendarId	Calendar Id
	szDescription	component Id
	iType	component Type
	pErrorCode	reference to error code

Returns:

long Alarm cookie value

Implemented in CAlarm.

virtual int CAlarmIface::deleteAlarmEvent	(	long	cookie,
		int &	pErrorCode
	)			[pure virtual]

deleteAlarmEvent Function to delete the alarm event

Parameters:

	long	Alarm cookie value
	pErrorCode	reference to Error code

Returns:

int Return value for delete alarm event

Implemented in CAlarm.

virtual long CAlarmIface::modifyAlarmEvent	(	long	oldcookie,
		time_t	modify_time,
		string	message,
		string	location,
		time_t	dateStart,
		time_t	dateEnd,
		string	sCompId,
		int	iCalendarId,
		string	szDescription,
		int	iType,
		bool	allday,
		string	szZone,
		int &	pErrorCode
	)			[pure virtual]

modifyAlarmEvent

Parameters:

	oldcookie	Old cookie value
	modify_time	Event time in time_t format
	message	Event summary displays in alarm message
	location	Event location displays in alarm message
	dateStart	Event start date
	dateEnd	Event end date
	iCalendarId	Calendar Id string
	szDescription	description
	iType	component Type
	pErrorCode	reference to error code

Returns:

long New Alarm cookie value

Function to modify the alarm event

Implemented in CAlarm.

---

The documentation for this class was generated from the following files:

• include/CAlarmIface.h
• src/CAlarmIface.cpp