Collapse all Symbian^3 Product Developer Library

CBIODatabase Class Reference

class CBIODatabase : public CBase

BIO information file (BIF) database.

This class reads the installed BIF files and allows information from them to be easily extracted.

BIO_INFO_FILE

Inherits from

CBIODatabase
- CBase

Public Member Functions
	~CBIODatabase()
IMPORT_C void	AddAllBifsL(RFs &)
IMPORT_C void	AddBifL(CBioInfoFileReader *)
IMPORT_C TInt	BIOCount()
IMPORT_C const CArrayFix< TBioMsgId > *	BIOEntryLC(TInt)
IMPORT_C const CBioInfoFileReader &	BifReader(TInt)
IMPORT_C const CArrayFix< TBioMsgId > *	BioEntryByTypeLC(TSearchList, TBioMsgIdType, TInt &)
IMPORT_C void	GetBioControlID(TInt, TUid &)
IMPORT_C void	GetBioControlIDL(TUid, TUid &)
IMPORT_C const TPtrC	GetBioControlName(TInt)
IMPORT_C const TPtrC	GetBioControlNameL(TUid)
IMPORT_C void	GetBioIndexWithMsgIDL(TUid, TInt &)
IMPORT_C void	GetBioMsgID(TInt, TUid &)
IMPORT_C const TPtrC	GetBioParserName(TInt)
IMPORT_C const TPtrC	GetBioParserNameL(TUid)
IMPORT_C void	GetDefaultSendBearerByTypeL(TUid, TBioMsgIdType, TBioMsgId &)
IMPORT_C void	GetDefaultSendBearerL(TUid, TBioMsgId &)
IMPORT_C void	GetDefaultSendBearerTypeL(TUid, TBioMsgIdType &)
IMPORT_C const TPtrC	GetFileExtL(TUid)
IMPORT_C void	GetIdentifierTextL(TUid, TBioMsgIdType, TBioMsgIdText &)
IMPORT_C void	GetPortNumberL(TUid, TBioMsgIdType, TInt &)
IMPORT_C TInt	IsBioMessageL(TBioMsgIdType, const TDesC &, TUint16, TUid &)
IMPORT_C TInt	IsBioMessageL(TBioMsgId, TUid &)
IMPORT_C CBIODatabase *	NewL(RFs &)
IMPORT_C CBIODatabase *	NewLC(RFs &)
IMPORT_C void	RemoveBifL(TUid)
IMPORT_C void	RemoveBifL(TInt)

Private Member Functions
	CBIODatabase()
void	ConstructL(RFs &)
void	GetTransportIDL(TInt, TBioMsgIdType, TBioMsgId &)
TBool	IsLanguageFileL(const TDesC &, TInt &)

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

Public Member Enumerations
enum	TSearchList { EStart, ENext }

Private Attributes
CArrayPtrFlat< CBioInfoFileReader > *	iBifReaders

Constructor & Destructor Documentation

CBIODatabase()

CBIODatabase

(

)

[private]

~CBIODatabase()

IMPORT_C

~CBIODatabase

(

)

Destructor.

Member Functions Documentation

AddAllBifsL(RFs &)

IMPORT_C void

AddAllBifsL

(

RFs &

afileSystem

)

Initialises the object from all the BIF files in the system\bif or resource\messaging\bif directory.

Parameters

RFs & afileSystem

Connected file system handle

AddBifL(CBioInfoFileReader *)

IMPORT_C void

AddBifL

(

CBioInfoFileReader *

aBifReader

)

Adds a specified BIF.

Parameters

CBioInfoFileReader * aBifReader

BIOCount()

IMPORT_C TInt

BIOCount

(

)

Gets the number of BIF files.

BIOEntryLC(TInt)

IMPORT_C const CArrayFix< TBioMsgId > *

BIOEntryLC

(

TInt

index

)

Gets the ID array of a BIF at a specified index.

Parameters

TInt index

Index

BifReader(TInt)

IMPORT_C const CBioInfoFileReader &

BifReader

(

TInt

aIndex

)

const

Gets a BIF reader for a BIF at a specified index.

Parameters

TInt aIndex

Index

BioEntryByTypeLC(TSearchList, TBioMsgIdType, TInt &)

IMPORT_C const CArrayFix< TBioMsgId > *	BioEntryByTypeLC	(	TSearchList	aSearchType,
			TBioMsgIdType	portType,
			TInt &	rIndex
		)

Gets the ID array of a BIF of a specified bearer source type.

Parameters

TSearchList aSearchType	Search type
TBioMsgIdType portType	Bearer source type
TInt & rIndex	On return, index of found BIF

ConstructL(RFs &)

void

ConstructL

(

RFs &

afileSystem

)

[private]

Parameters

RFs & afileSystem

GetBioControlID(TInt, TUid &)

IMPORT_C void	GetBioControlID	(	TInt	aIndex,
			TUid &	rControlID
		)

Depreacated method.

Need to use CBIODatabase::GetBioControlName instead.

CBIODatabase::GetBioControlName

panic: USER EInvariantFalse

Parameters

TInt aIndex	Not used
TUid & rControlID	Not used

GetBioControlIDL(TUid, TUid &)

IMPORT_C void	GetBioControlIDL	(	TUid	aMsgID,
			TUid &	rControlID
		)

Depreacated method.

Need to use CBIODatabase::GetBioControlNameL instead.

CBIODatabase::GetBioControlNameL

panic: USER EInvariantFalse

Parameters

TUid aMsgID
TUid & rControlID	Not used

GetBioControlName(TInt)

IMPORT_C const TPtrC

GetBioControlName

(

TInt

aIndex

)

Gets the BIO control name for a specified index.

Parameters

TInt aIndex

Index

GetBioControlNameL(TUid)

IMPORT_C const TPtrC

GetBioControlNameL

(

TUid

aMsgID

)

Gets the BIO control name for a specified BIO message type.

leave: KErrNotFound BIO message type does not exist

Parameters

TUid aMsgID

BIO message type

GetBioIndexWithMsgIDL(TUid, TInt &)

IMPORT_C void	GetBioIndexWithMsgIDL	(	TUid	aMsgID,
			TInt &	rIndex
		)

Gets the index of a BIF of a specified BIO message type.

leave: KErrNotFound Not found

Parameters

TUid aMsgID	BIO message type
TInt & rIndex	On return, index of found BIF

GetBioMsgID(TInt, TUid &)

IMPORT_C void	GetBioMsgID	(	TInt	aIndex,
			TUid &	rMsgID
		)

Gets the BIO message type for a specified index.

Parameters

TInt aIndex	Index
TUid & rMsgID	On return, BIO message type

GetBioParserName(TInt)

IMPORT_C const TPtrC

GetBioParserName

(

TInt

aIndex

)

Gets the BIO parser name for a specified index.

Parameters

TInt aIndex

Index

GetBioParserNameL(TUid)

IMPORT_C const TPtrC

GetBioParserNameL

(

TUid

aMsgID

)

Gets the BIO parser name for a specified BIO message type.

leave: KErrNotFound Not found

Parameters

TUid aMsgID

BIO message type

GetDefaultSendBearerByTypeL(TUid, TBioMsgIdType, TBioMsgId &)

IMPORT_C void	GetDefaultSendBearerByTypeL	(	TUid	aBioUID,
			TBioMsgIdType	aPortType,
			TBioMsgId &	rBioMsgIdentifier
		)

Gets the default BIF ID entry for a specified BIO message type and bearer type.

leave: KErrNotFound Not found

Parameters

TUid aBioUID	BIO message type
TBioMsgIdType aPortType	Bearer type
TBioMsgId & rBioMsgIdentifier	On return, the default BIF ID entry

GetDefaultSendBearerL(TUid, TBioMsgId &)

IMPORT_C void	GetDefaultSendBearerL	(	TUid	aBioUID,
			TBioMsgId &	rBioMsgIdentifier
		)

Gets the default BIF ID entry for a specified BIO message type.

leave: KErrNotFound Not found

Parameters

TUid aBioUID	BIO message type
TBioMsgId & rBioMsgIdentifier	On return, the default BIF ID entry

GetDefaultSendBearerTypeL(TUid, TBioMsgIdType &)

IMPORT_C void	GetDefaultSendBearerTypeL	(	TUid	aBioUID,
			TBioMsgIdType &	rPortType
		)

Gets the bearer type for the default BIF ID entry for a specified BIO message type.

leave: KErrNotFound Not found

Parameters

TUid aBioUID	BIO message type
TBioMsgIdType & rPortType	On return, the bearer type

GetFileExtL(TUid)

IMPORT_C const TPtrC

GetFileExtL

(

TUid

aMsgID

)

Gets the BIO file extension for a specified BIO message type.

leave: KErrNotFound Not found

Parameters

TUid aMsgID

BIO message type

GetIdentifierTextL(TUid, TBioMsgIdType, TBioMsgIdText &)

IMPORT_C void	GetIdentifierTextL	(	TUid	aMsgID,
			TBioMsgIdType	aPortType,
			TBioMsgIdText &	aText
		)

Gets the identifier text for the BIF ID entry for a specified BIO message type and bearer type.

Parameters

TUid aMsgID	BIO message type
TBioMsgIdType aPortType	Bearer type
TBioMsgIdText & aText	On return, the identifier text

GetPortNumberL(TUid, TBioMsgIdType, TInt &)

IMPORT_C void	GetPortNumberL	(	TUid	aMsgID,
			TBioMsgIdType	aPortType,
			TInt &	aPortNumber
		)

Gets the port number for the BIF ID entry for a specified BIO message type and bearer type.

leave: KErrNotFound Not found

Parameters

TUid aMsgID	BIO message type
TBioMsgIdType aPortType	Bearer type
TInt & aPortNumber	On return, the port number

GetTransportIDL(TInt, TBioMsgIdType, TBioMsgId &)

void	GetTransportIDL	(	TInt	aIndex,
			TBioMsgIdType	aPortType,
			TBioMsgId &	aBioMsgID
		)	[private]

Parameters

TInt aIndex
TBioMsgIdType aPortType
TBioMsgId & aBioMsgID

IsBioMessageL(TBioMsgIdType, const TDesC &, TUint16, TUid &)

IMPORT_C TInt	IsBioMessageL	(	TBioMsgIdType	aPortType,
			const TDesC &	aPattern,
			TUint16	aPort,
			TUid &	rBioMsgUID
		)

Tests if there is a BIO parser for the specificed BIF ID settings.

Parameters

TBioMsgIdType aPortType	Bearer type
const TDesC & aPattern	Text identifier to match
TUint16 aPort	Port to match
TUid & rBioMsgUID	On return, the matching BIO message type

IsBioMessageL(TBioMsgId, TUid &)

IMPORT_C TInt	IsBioMessageL	(	TBioMsgId	bioMessageData,
			TUid &	rBioMsgUID
		)

Tests if there is a BIO parser for a specified BIF ID.

Parameters

TBioMsgId bioMessageData	BIF ID to match
TUid & rBioMsgUID	On return, the matching BIO message type

IsLanguageFileL(const TDesC &, TInt &)

TBool	IsLanguageFileL	(	const TDesC &	aFileName,
			TInt &	aExtLength
		)	const [private]

Parameters

const TDesC & aFileName
TInt & aExtLength

NewL(RFs &)

IMPORT_C CBIODatabase *

NewL

(

RFs &

afileSystem

)

[static]

Allocates and constructs a new BIO database object.

It initialises the object from all the BIF files in the system\bif directory.

Parameters

RFs & afileSystem

Connected file system handle

NewLC(RFs &)

IMPORT_C CBIODatabase *

NewLC

(

RFs &

afileSystem

)

[static]

Allocates and constructs a new BIO database object, leaving the object on the cleanup stack.

It initialises the object from all the BIF files in the system\bif directory.

Parameters

RFs & afileSystem

Connected file system handle

RemoveBifL(TUid)

IMPORT_C void

RemoveBifL

(

TUid

aMsgID

)

Removes a BIF specified by UID.

Parameters

TUid aMsgID

BIO type UID

RemoveBifL(TInt)

IMPORT_C void

RemoveBifL

(

TInt

aIndex

)

Removes a BIF specified by index.

Parameters

TInt aIndex

Index of file in this object

Member Enumerations Documentation

Enum TSearchList

Search methods.

Enumerators

EStart	Begin search from the start.
ENext	Begin search from the last index position.

Member Data Documentation

CArrayPtrFlat< CBioInfoFileReader > * iBifReaders

CArrayPtrFlat< CBioInfoFileReader > *

iBifReaders

[private]