Please note that as of October 24, 2014, the Nokia Developer Wiki will no longer be accepting user contributions, including new entries, edits and comments, as we begin transitioning to our new home, in the Windows Phone Development Wiki. We plan to move over the majority of the existing entries. Thanks for all your past and future contributions.

Revision as of 14:21, 4 October 2012 by lpvalente (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Archived:Calendar Exporter Symbian API

From Wiki
Jump to: navigation, search

Archived.pngArchived: This article is archived because it is not considered relevant for third-party developers creating commercial solutions today. If you think this article is still relevant, let us know by adding the template {{ReviewForRemovalFromArchive|user=~~~~|write your reason here}}.

Article Metadata
Code ExampleCompatibility
Platform(s): S60 3rd Edition, FP2
S60 3rd Edition FP2
Keywords: Calendar Exporter API
Created: User:Technical writer 1 (13 Jun 2008)
Last edited: lpvalente (04 Oct 2012)

Note.pngNote: :This API is not part of the public SDK. It can be found in the SDK API Plug-in.



The Calendar Exporter API provides functions to export agenda entries to vCalendar data.

Header files

 #include <calsession.h>
#include <calprogresscallback.h>
#include <calentryview.h>
#include <calenexporter.h>
#include <caliterator.h>
#include <f32file.h>
#include <S32FILE.H>
#include <agnexportobserver.h>

Libraries used

 efsrv.lib calinterimapi.lib calenimp.lib estor.lib

Code example

The CCalSession is the interface to the Calendar file. The instantiation of CCalSession will result in a connection to the Calendar Server.

 void CCalendarEventsEngine::ConstructL()
iCalSession = CCalSession::NewL();
//Open the default calendar file
iWaiter =new (ELeave) CActiveSchedulerWait;
// calender exporter

Virtual functions

 // Called during calendar entry view creation
void CCalendarEventsEngine::Progress(TInt aProgress)
// Called on completion of calendar entry view creation
void CCalendarEventsEngine::Completed(TInt aError)
// Returns whether or not progress notification is required
TBool CCalendarEventsEngine::NotifyProgress()
// Progress notification is required
return ETrue;

The following code exports calender entries to a file:

 void CCalendarEventsEngine::ExportEntriesL()
// view class for accessing calendar entries
iCalEntryView = CCalEntryView::NewL(*iCalSession,*this);
// An iterator for iterating though all the entries in the calendar store
CCalIter* calIter = CCalIter::NewL(*iCalSession);
TBuf8<150> iterUID;
// An array of calender entries
RPointerArray<CCalEntry> calEntryArray;
iterUID = calIter->FirstL();
// calender entries file
TInt err = iRWriteStream.Open(iFs,KFile,EFileWrite);
if(err !=KErrNone)
User::LeaveIfError(iRWriteStream.Create(iFs, KFile, EFileWrite));
while (iterUID != KNullDesC8)
// get entries associated with this UID
iCalEntryView->FetchL(iterUID, calEntryArray);
for (TInt k=0; k<calEntryArray.Count();k++)
// get information from this entry
CCalEntry* calEntry = calEntryArray[k];
// export calender entry
iterUID = calIter->NextL();
delete calIter;
delete iCalEntryView;

Sample application

The following sample application is tested in the S60 3rd Edition, FP2 emulator.

This page was last modified on 4 October 2012, at 14:21.
39 page views in the last 30 days.