ReportFilterReturnCalendarData Property

Controls whether the contents of each calendar event is returned in the report.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetReportFilterReturnCalendarData();
int SetReportFilterReturnCalendarData(int bReportFilterReturnCalendarData);

Unicode (Windows)
BOOL GetReportFilterReturnCalendarData();
INT SetReportFilterReturnCalendarData(BOOL bReportFilterReturnCalendarData);

@property (nonatomic,readwrite,assign,getter=reportFilterReturnCalendarData,setter=setReportFilterReturnCalendarData:) BOOL reportFilterReturnCalendarData;
- (BOOL)reportFilterReturnCalendarData;
- (void)setReportFilterReturnCalendarData:(BOOL)newReportFilterReturnCalendarData;

#define PID_CALDAV_REPORTFILTERRETURNCALENDARDATA 84

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);

Default Value

TRUE

Remarks

Controls whether the contents of each calendar event is returned in the report.

If ReportFilterReturnCalendarData is True (default), a report will contain the full contents of each event in the calendar. This can be a substantially large amount of data. However if ReportFilterReturnCalendarData is False, the report returned will contain only URIs and ETags of each calendar event. You may compare the URIs against a cached list and retrieve any new URIs individually via the CalDAV.GetCalendarEvent method. If the ETag for a cached URI has changed, it means that the calendar event has changed, and needs to be retrieved.

Note that this filter is not compatible with the ReportFilterRecurStart and ReportFilterRecurEnd properties.

Data Type

Boolean