CBCardEngine Class Reference

#include <app/BCardEng.h>

Link against: BCardEng.lib

class CBCardEngine : public CBase

Inherits from

CBCardEngine

Public Member Functions
	~CBCardEngine()
IMPORT_C void	ExportBusinessCardL(RWriteStream &, CPbkContactItem &)
IMPORT_C void	ImportBusinessCardL(CPbkContactItem &, RReadStream &)
IMPORT_C TBool	ImportCompactBusinessCardL(CPbkContactItem &, RReadStream &)
IMPORT_C CBCardEngine *	NewL(CPbkContactEngine *)
IMPORT_C TBool	SupportsFieldType(TPbkFieldId)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

The business card engine is able to import and export vCards and Compact Business Cards to and from Phonebook.

Constructor & Destructor Documentation

~CBCardEngine ( )

IMPORT_C

~CBCardEngine

(

)

Destructor

Member Function Documentation

ExportBusinessCardL ( RWriteStream &, CPbkContactItem & )

IMPORT_C void	ExportBusinessCardL	(	RWriteStream &	aDestStream,
			CPbkContactItem &	aSourceItem
		)

Writes a vCard record with information from a Phonebook contact item. The main Export function.

Parameter	Description
aDestStream	A stream where the vCard data is written to. The data written to the stream is not Committed by this method.
aSourceItem	Phonebook contact item where the information should be read from

ImportBusinessCardL ( CPbkContactItem &, RReadStream & )

IMPORT_C void	ImportBusinessCardL	(	CPbkContactItem &	aDestItem,
			RReadStream &	aSourceStream
		)

Reads a vCard record from a stream into a Phonebook contact item.

Parameter	Description
aDestItem	Phonebook contact item where the information should be written to. The item should be writable. The caller should commit the changes.
aSourceStream	A stream where the vCard data is read from

ImportCompactBusinessCardL ( CPbkContactItem &, RReadStream & )

IMPORT_C TBool	ImportCompactBusinessCardL	(	CPbkContactItem &	aDestItem,
			RReadStream &	aSourceStream
		)

Reads a Compact Business Card record from a stream into a Phonebook contact item.

Parameter	Description
aDestItem	Phonebook contact item where the information must be written to. The item must be writable. The caller should commit the changes.
aSourceStream	A stream where the Compact Business Card is read from

Returns: ETrue on success

NewL ( CPbkContactEngine * )

IMPORT_C CBCardEngine *

NewL

(

CPbkContactEngine *

aEngine

)

[static]

Creates a new instance of this class.

Parameter	Description
aEngine	An open Phonebook Engine object which CBCardEngine uses to import and export vCard data.

SupportsFieldType ( TPbkFieldId )

IMPORT_C TBool

SupportsFieldType

(

TPbkFieldId

aFieldId

)

Checks if given field is supported by the vCard format

Parameter	Description
aFieldId	Field id type

Returns: ETrue if given field is supported, EFalse otherwise