CBIODatabase Class Reference

#include <mw/biodb.h>

Link against: biodb.lib

class CBIODatabase : public CBase, public CBase

Inherits from

CBIODatabase
- CBase
- CBase

Public Member Enumerations
enum	TSearchList { EStart, ENext }

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)

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

BIO information file (BIF) database.

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

Member Enumeration Documentation

Enum TSearchList

Search methods.

Enumerator	Value	Description
EStart		Begin search from the start.
ENext		Begin search from the last index position.

Constructor & Destructor Documentation

~CBIODatabase ( )

IMPORT_C

~CBIODatabase

(

)

Destructor.

Member Function 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
afileSystem	Connected file system handle

AddBifL ( CBioInfoFileReader * )

IMPORT_C void

AddBifL

(

CBioInfoFileReader *

aBifReader

)

Adds a specified BIF.

BIOCount ( )

IMPORT_C TInt

BIOCount

(

)

Gets the number of BIF files.

Return Value: 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
index	Index

Return Value: ID array, or NULL if not found

BifReader ( TInt )

IMPORT_C const CBioInfoFileReader &

BifReader

(

TInt

aIndex

)

const

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

Parameters
aIndex	Index

Return Value: BIF file reader

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
aSearchType	Search type
portType	Bearer source type
rIndex	On return, index of found BIF

Return Value: ID array, or NULL if not found

GetBioControlID ( TInt, TUid & )

IMPORT_C void	GetBioControlID	(	TInt	aIndex,
			TUid &	rControlID
		)

Deprecated

Depreacated method.

Need to use CBIODatabase::GetBioControlName instead.

Parameters
aIndex	Not used
rControlID	Not used

Panic Codes
USER	EInvariantFalse

GetBioControlIDL ( TUid, TUid & )

IMPORT_C void	GetBioControlIDL	(	TUid	aMsgID,
			TUid &	rControlID
		)

Deprecated

Depreacated method.

Need to use CBIODatabase::GetBioControlNameL instead.

Parameters
rControlID	Not used

Panic Codes
USER	EInvariantFalse

GetBioControlName ( TInt )

IMPORT_C const TPtrC

GetBioControlName

(

TInt

aIndex

)

Gets the BIO control name for a specified index.

Parameters
aIndex	Index

Return Value: BIO control name

GetBioControlNameL ( TUid )

IMPORT_C const TPtrC

GetBioControlNameL

(

TUid

aMsgID

)

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

Parameters
aMsgID	BIO message type

Return Value: BIO Control name

Leave Codes
KErrNotFound	BIO message type does not exist

GetBioIndexWithMsgIDL ( TUid, TInt & )

IMPORT_C void	GetBioIndexWithMsgIDL	(	TUid	aMsgID,
			TInt &	rIndex
		)

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

Parameters
aMsgID	BIO message type
rIndex	On return, index of found BIF

Leave Codes
KErrNotFound	Not found

GetBioMsgID ( TInt, TUid & )

IMPORT_C void	GetBioMsgID	(	TInt	aIndex,
			TUid &	rMsgID
		)

Gets the BIO message type for a specified index.

Parameters
aIndex	Index
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
aIndex	Index

Return Value: BIO parser name

GetBioParserNameL ( TUid )

IMPORT_C const TPtrC

GetBioParserNameL

(

TUid

aMsgID

)

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

Parameters
aMsgID	BIO message type

Return Value: BIO parser name

Leave Codes
KErrNotFound	Not found

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.

Parameters
aBioUID	BIO message type
aPortType	Bearer type
rBioMsgIdentifier	On return, the default BIF ID entry

Leave Codes
KErrNotFound	Not found

GetDefaultSendBearerL ( TUid, TBioMsgId & )

IMPORT_C void	GetDefaultSendBearerL	(	TUid	aBioUID,
			TBioMsgId &	rBioMsgIdentifier
		)

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

Parameters
aBioUID	BIO message type
rBioMsgIdentifier	On return, the default BIF ID entry

Leave Codes
KErrNotFound	Not found

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.

Parameters
aBioUID	BIO message type
rPortType	On return, the bearer type

Leave Codes
KErrNotFound	Not found

GetFileExtL ( TUid )

IMPORT_C const TPtrC

GetFileExtL

(

TUid

aMsgID

)

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

Parameters
aMsgID	BIO message type

Return Value: BIO file extension

Leave Codes
KErrNotFound	Not found

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
aMsgID	BIO message type
aPortType	Bearer type
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.

Parameters
aMsgID	BIO message type
aPortType	Bearer type
aPortNumber	On return, the port number

Leave Codes
KErrNotFound	Not found

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
aPortType	Bearer type
aPattern	Text identifier to match
aPort	Port to match
rBioMsgUID	On return, the matching BIO message type

Return Value: KErrNone if found, else KErrNotFound

IsBioMessageL ( TBioMsgId, TUid & )

IMPORT_C TInt	IsBioMessageL	(	TBioMsgId	bioMessageData,
			TUid &	rBioMsgUID
		)

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

Parameters
bioMessageData	BIF ID to match
rBioMsgUID	On return, the matching BIO message type

Return Value: KErrNone if found, else KErrNotFound

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
afileSystem	Connected file system handle

Return Value: New BIO database object

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
afileSystem	Connected file system handle

Return Value: New BIO database object

RemoveBifL ( TUid )

IMPORT_C void

RemoveBifL

(

TUid

aMsgID

)

Removes a BIF specified by UID.

Parameters
aMsgID	BIO type UID

RemoveBifL ( TInt )

IMPORT_C void

RemoveBifL

(

TInt

aIndex

)

Removes a BIF specified by index.

Parameters
aIndex	Index of file in this object