#include <caldataexchange.h>
class CCalDataExchange : public CBase;
Description
This class provides functionality for importing and exporting vCal entries.
Derivation
CBase -
Base class for all classes to be instantiated on the heap.
CCalDataExchange - This class provides functionality for importing and exporting vCal entries.
Members
Defined in CCalDataExchange:
ExportAsyncL(TUid,RWriteStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &)Asynchronously exports data of aDataFormat type from an array of CCalEntries cor...ExportAsyncL(TUid,RWriteStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &)ExportL(TUid,RWriteStream &,RPointerArray< CCalEntry > &)Exports data of aDataFormat type from an array of CCalEntries corresponding to t...ExportL(TUid,RWriteStream &,RPointerArray< CCalEntry > &)ImportAsyncL(TUid,RReadStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &,TInt)Asynchronously imports data of aDataFormat type and returns an array of CCalEntr...ImportAsyncL(TUid,RReadStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &,TInt)ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &)Imports data of aDataFormat type and returns an array of CCalEntries correspondi...ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &)ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt)Imports data of aDataFormat type and returns an array of CCalEntries correspondi...ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt)ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt,TInt)Imports data of aDataFormat type and returns an array of a selected number of CC...ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt,TInt)NewL(CCalSession &)Allocates and constructs a CCalDataExchange object. NewL(CCalSession &)~CCalDataExchange()Destructor ~CCalDataExchange()
Inherited from CBase:
Construction and destruction
IMPORT_C static CCalDataExchange* NewL(CCalSession &aSession);
Description
Allocates and constructs a CCalDataExchange object.
Parameters
CCalSession &aSession |
The handle to the calender session.
|
|
Return value
IMPORT_C ~CCalDataExchange();
Description
Destructor
IMPORT_C static CCalDataExchange* NewL(CCalSession &aSession);
Description
Parameters
Return value
IMPORT_C ~CCalDataExchange();
Description
ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray);
Description
Imports data of aDataFormat type and returns an array of CCalEntries corresponding to this data
Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities
are converted into CCalEntries and passed back in the array parameter aCalEntryArray.
Parameters
TUid aDataFormat |
Specifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
|
RReadStream &aReadStream |
The read stream which contains the (vCalendar) data.
|
RPointerArray< CCalEntry > &aCalEntryArray |
On return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are
specific to the data format
|
|
ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray, TInt aFlags);
Description
Imports data of aDataFormat type and returns an array of CCalEntries corresponding to this data
Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities
are converted into CCalEntries and passed back in the array parameter aCalEntryArray.
Parameters
TUid aDataFormat |
Specifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
|
RReadStream &aReadStream |
The read stream which contains the (vCalendar) data.
|
RPointerArray< CCalEntry > &aCalEntryArray |
On return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are
specific to the data format
|
TInt aFlags |
controls the behaviour of the parser during the import process.
|
|
ExportL(TUid,RWriteStream &,RPointerArray< CCalEntry > &)
IMPORT_C void ExportL(TUid aDataFormat, RWriteStream &aWriteStream, RPointerArray< CCalEntry > &aCalEntryArray);
Description
Exports data of aDataFormat type from an array of CCalEntries corresponding to this data
Currently only VCal 1.0 (with extensions) is supported. The entry is exported either as a vTodo (if it is a to-do), or as
a vEvent. The exported property values are converted from Unicode into the character set indicated by the last parameter (UTF-8
by default).
Parameters
TUid aDataFormat |
Specifies the format of the data to be exported. Currently this must be KUidVCalendar (see CalDataFormat.h)
|
RWriteStream &aWriteStream |
The stream to which the calender entries should be externalised.
|
RPointerArray< CCalEntry > &aCalEntryArray |
The array of calender entries to export.
|
|
ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray);
Description
Parameters
ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray, TInt aFlags);
Description
Parameters
ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt,TInt)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray, TInt aFlags,
TInt aNumEntries);
Description
Imports data of aDataFormat type and returns an array of a selected number of CCalEntries corresponding to this data.
Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities
are converted into CCalEntries and passed back in the array parameter aCalEntryArray.
Parameters
TUid aDataFormat |
Specifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
|
RReadStream &aReadStream |
The read stream which contains the (vCalendar) data.
|
RPointerArray< CCalEntry > &aCalEntryArray |
On return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are
specific to the data format
|
TInt aFlags |
controls the behaviour of the parser during the import process.
|
TInt aNumEntries |
Specifies how many entries are to be imported at once.
|
|
ExportL(TUid,RWriteStream &,RPointerArray< CCalEntry > &)
IMPORT_C void ExportL(TUid aDataFormat, RWriteStream &aWriteStream, RPointerArray< CCalEntry > &aCalEntryArray);
Description
Parameters
ImportAsyncL(TUid,RReadStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &,TInt)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportAsyncL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray, MCalDataExchangeCallBack
&aObserver, TInt aFlags);
Description
Asynchronously imports data of aDataFormat type and returns an array of CCalEntries corresponding to this data
Currently only VCal 1.0 (with extensions) is supported. The vCalendar is read from the read stream specified and its entities
are converted into CCalEntries and passed back in the array parameter aCalEntryArray.
Parameters
TUid aDataFormat |
Specifies the format of the data to be imported. Currently this must be KUidVCalendar (see CalDataFormat.h)
|
RReadStream &aReadStream |
The read stream which contains the (vCalendar) data.
|
RPointerArray< CCalEntry > &aCalEntryArray |
On return, a list of the calender entries which were imported. The list contains the vEvents followed by the vTodos and are
specific to the data format
|
MCalDataExchangeCallBack &aObserver |
Callback class to indicate the progress of the import and when it has completed.
|
TInt aFlags |
controls the behaviour of the parser during the import process.
|
|
ImportL(TUid,RReadStream &,RPointerArray< CCalEntry > &,TInt,TInt)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray, TInt aFlags,
TInt aNumEntries);
Description
Parameters
ExportAsyncL(TUid,RWriteStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &)
IMPORT_C void ExportAsyncL(TUid aDataFormat, RWriteStream &aWriteStream, RPointerArray< CCalEntry > &aCalEntryArray, MCalDataExchangeCallBack
&aObserver);
Description
Asynchronously exports data of aDataFormat type from an array of CCalEntries corresponding to this data
Currently only VCal 1.0 (with extensions) is supported. The entry is exported either as a vTodo (if it is a to-do), or as
a vEvent. The exported property values are converted from Unicode into the character set indicated by the last parameter (UTF-8
by default).
Parameters
TUid aDataFormat |
Specifies the format of the data to be exported. Currently this must be KUidVCalendar (see CalDataFormat.h)
|
RWriteStream &aWriteStream |
The stream to which the calender entries should be externalised.
|
RPointerArray< CCalEntry > &aCalEntryArray |
The array of calender entries to export.
|
MCalDataExchangeCallBack &aObserver |
Callback class to indicate the progress of the import and when it has completed.
|
|
ImportAsyncL(TUid,RReadStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &,TInt)
| Capability: |
WriteUserData |
|
IMPORT_C void ImportAsyncL(TUid aDataFormat, RReadStream &aReadStream, RPointerArray< CCalEntry > &aCalEntryArray, MCalDataExchangeCallBack
&aObserver, TInt aFlags);
Description
Parameters
ExportAsyncL(TUid,RWriteStream &,RPointerArray< CCalEntry > &,MCalDataExchangeCallBack &)
IMPORT_C void ExportAsyncL(TUid aDataFormat, RWriteStream &aWriteStream, RPointerArray< CCalEntry > &aCalEntryArray, MCalDataExchangeCallBack
&aObserver);
Description
Parameters
![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)