Class CBIODatabase

class CBIODatabase : public CBase;

Description

BIO information file (BIF) database.

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CBIODatabase - BIO information file (BIF) database

Members

Defined in CBIODatabase:
AddAllBifsL(), AddBifL(), BIOCount(), BIOEntryLC(), BifReader(), BioEntryByTypeLC(), ENext, EStart, GetBioControlID(), GetBioControlIDL(), GetBioControlName(), GetBioControlNameL(), GetBioIndexWithMsgIDL(), GetBioMsgID(), GetBioParserName(), GetBioParserNameL(), GetDefaultSendBearerByTypeL(), GetDefaultSendBearerL(), GetDefaultSendBearerTypeL(), GetFileExtL(), GetIdentifierTextL(), GetPortNumberL(), IsBioMessageL(), IsBioMessageL(), NewL(), NewLC(), RemoveBifL(), RemoveBifL(), TSearchList, ~CBIODatabase()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CBIODatabase *NewLC(RFs &afileSystem);

Description

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

Return value

CBIODatabase * New BIO database object

static IMPORT_C CBIODatabase *NewL(RFs &afileSystem);

Description

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

Return value

CBIODatabase * New BIO database object

IMPORT_C ~CBIODatabase();

Description

Destructor.

IMPORT_C void AddAllBifsL(RFs &afileSystem);

Description

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

Parameters

RFs &afileSystem Connected file system handle

IMPORT_C void AddBifL(CBioInfoFileReader *aBifReader);

Description

Adds a specified BIF.

Parameters

CBioInfoFileReader *aBifReader

IMPORT_C void RemoveBifL(TUid aMsgID);

Description

Removes a BIF specified by UID.

Parameters

TUid aMsgID BIO type UID

IMPORT_C void RemoveBifL(TInt aIndex);

Description

Removes a BIF specified by index.

Parameters

TInt aIndex Index of file in this object

IMPORT_C TInt BIOCount();

Description

Gets the number of BIF files.

Return value

TInt Number of BIF files

IMPORT_C const CArrayFix< TBioMsgId > *BIOEntryLC(TInt index);

Description

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

Parameters

TInt index Index

Return value

const CArrayFix< TBioMsgId > * ID array, or NULL if not found

IMPORT_C const CBioInfoFileReader &BifReader(TInt aIndex) const;

Description

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

Parameters

TInt aIndex Index

Return value

const CBioInfoFileReader & BIF file reader

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

Description

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

Return value

const CArrayFix< TBioMsgId > * ID array, or NULL if not found

IMPORT_C void GetBioIndexWithMsgIDL(TUid aMsgID, TInt &rIndex);

Description

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

Parameters

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

Leave codes

KErrNotFound Not found

IMPORT_C void GetBioMsgID(TInt aIndex, TUid &rMsgID);

Description

Gets the BIO message type for a specified index.

Parameters

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

IMPORT_C const TPtrC GetBioParserName(TInt aIndex);

Description

Gets the BIO parser name for a specified index.

Parameters

TInt aIndex Index

Return value

const TPtrC BIO parser name

IMPORT_C const TPtrC GetBioParserNameL(TUid aMsgID);

Description

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

Parameters

TUid aMsgID BIO message type

Return value

const TPtrC BIO parser name

Leave codes

KErrNotFound Not found

IMPORT_C void GetBioControlID(TInt aIndex, TUid &rControlID);

Description

Depreacated method.

Need to use CBIODatabase::GetBioControlName instead.

Parameters

TInt aIndex Not used TUid &rControlID Not used

Panic codes

USER EInvariantFalse

IMPORT_C void GetBioControlIDL(TUid aMsgID, TUid &rControlID);

Description

Depreacated method.

Need to use CBIODatabase::GetBioControlNameL instead.

Parameters

TUid aMsgID TUid &rControlID Not used

Panic codes

USER EInvariantFalse

IMPORT_C const TPtrC GetBioControlName(TInt aIndex);

Description

Gets the BIO control name for a specified index.

Parameters

TInt aIndex Index

Return value

const TPtrC BIO control name

IMPORT_C const TPtrC GetBioControlNameL(TUid aMsgID);

Description

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

Parameters

TUid aMsgID BIO message type

Return value

const TPtrC BIO Control name

Leave codes

KErrNotFound BIO message type does not exist

IMPORT_C const TPtrC GetFileExtL(TUid aMsgID);

Description

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

Parameters

TUid aMsgID BIO message type

Return value

const TPtrC BIO file extension

Leave codes

KErrNotFound Not found

IMPORT_C void GetDefaultSendBearerL(TUid aBioUID, TBioMsgId &rBioMsgIdentifier);

Description

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

Parameters

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

Leave codes

KErrNotFound Not found

IMPORT_C void GetDefaultSendBearerTypeL(TUid aBioUID, TBioMsgIdType &rPortType);

Description

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

Parameters

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

Leave codes

KErrNotFound Not found

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

Description

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

Parameters

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

Leave codes

KErrNotFound Not found

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

Description

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

Parameters

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

Leave codes

KErrNotFound Not found

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

Description

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

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

Description

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

Return value

TInt KErrNone if found, else KErrNotFound

IMPORT_C TInt IsBioMessageL(TBioMsgId bioMessageData, TUid &rBioMsgUID);

Description

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

Return value

TInt KErrNone if found, else KErrNotFound

TSearchList

Description

Search methods.

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