CBIODatabase Class Reference

#include <mw/biodb.h>

Link against: biodb.lib

class CBIODatabase : public CBase, public CBase

Inherits from

Public Member Enumerations
enumTSearchList { EStart, ENext }
Public Member Functions
~CBIODatabase()
IMPORT_C voidAddAllBifsL(RFs &)
IMPORT_C voidAddBifL(CBioInfoFileReader *)
IMPORT_C TIntBIOCount()
IMPORT_C const CArrayFix< TBioMsgId > *BIOEntryLC(TInt)
IMPORT_C const CBioInfoFileReader &BifReader(TInt)
IMPORT_C const CArrayFix< TBioMsgId > *BioEntryByTypeLC(TSearchList, TBioMsgIdType, TInt &)
IMPORT_C voidGetBioControlID(TInt, TUid &)
IMPORT_C voidGetBioControlIDL(TUid, TUid &)
IMPORT_C const TPtrCGetBioControlName(TInt)
IMPORT_C const TPtrCGetBioControlNameL(TUid)
IMPORT_C voidGetBioIndexWithMsgIDL(TUid, TInt &)
IMPORT_C voidGetBioMsgID(TInt, TUid &)
IMPORT_C const TPtrCGetBioParserName(TInt)
IMPORT_C const TPtrCGetBioParserNameL(TUid)
IMPORT_C voidGetDefaultSendBearerByTypeL(TUid, TBioMsgIdType, TBioMsgId &)
IMPORT_C voidGetDefaultSendBearerL(TUid, TBioMsgId &)
IMPORT_C voidGetDefaultSendBearerTypeL(TUid, TBioMsgIdType &)
IMPORT_C const TPtrCGetFileExtL(TUid)
IMPORT_C voidGetIdentifierTextL(TUid, TBioMsgIdType, TBioMsgIdText &)
IMPORT_C voidGetPortNumberL(TUid, TBioMsgIdType, TInt &)
IMPORT_C TIntIsBioMessageL(TBioMsgIdType, const TDesC &, TUint16, TUid &)
IMPORT_C TIntIsBioMessageL(TBioMsgId, TUid &)
IMPORT_C CBIODatabase *NewL(RFs &)
IMPORT_C CBIODatabase *NewLC(RFs &)
IMPORT_C voidRemoveBifL(TUid)
IMPORT_C voidRemoveBifL(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.

See also: BIO_INFO_FILE

Member Enumeration Documentation

Enum TSearchList

Search methods.

EnumeratorValueDescription
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 voidAddAllBifsL(RFs &afileSystem)

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

Parameters
afileSystemConnected file system handle

AddBifL ( CBioInfoFileReader * )

IMPORT_C voidAddBifL(CBioInfoFileReader *aBifReader)

Adds a specified BIF.

BIOCount ( )

IMPORT_C TIntBIOCount()

Gets the number of BIF files.

Return Value
Number of BIF files

BIOEntryLC ( TInt )

IMPORT_C const CArrayFix< TBioMsgId > *BIOEntryLC(TIntindex)

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

Parameters
indexIndex
Return Value
ID array, or NULL if not found

BifReader ( TInt )

IMPORT_C const CBioInfoFileReader &BifReader(TIntaIndex)const

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

Parameters
aIndexIndex
Return Value
BIF file reader

BioEntryByTypeLC ( TSearchList, TBioMsgIdType, TInt & )

IMPORT_C const CArrayFix< TBioMsgId > *BioEntryByTypeLC(TSearchListaSearchType,
TBioMsgIdTypeportType,
TInt &rIndex
)

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

Parameters
aSearchTypeSearch type
portTypeBearer source type
rIndexOn return, index of found BIF
Return Value
ID array, or NULL if not found

GetBioControlID ( TInt, TUid & )

IMPORT_C voidGetBioControlID(TIntaIndex,
TUid &rControlID
)
Deprecated

Depreacated method.

Need to use CBIODatabase::GetBioControlName instead.

See also: CBIODatabase::GetBioControlName

Parameters
aIndexNot used
rControlIDNot used
Panic Codes
USEREInvariantFalse

GetBioControlIDL ( TUid, TUid & )

IMPORT_C voidGetBioControlIDL(TUidaMsgID,
TUid &rControlID
)
Deprecated

Depreacated method.

Need to use CBIODatabase::GetBioControlNameL instead.

See also: CBIODatabase::GetBioControlNameL

Parameters
rControlIDNot used
Panic Codes
USEREInvariantFalse

GetBioControlName ( TInt )

IMPORT_C const TPtrCGetBioControlName(TIntaIndex)

Gets the BIO control name for a specified index.

Parameters
aIndexIndex
Return Value
BIO control name

GetBioControlNameL ( TUid )

IMPORT_C const TPtrCGetBioControlNameL(TUidaMsgID)

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

Parameters
aMsgIDBIO message type
Return Value
BIO Control name
Leave Codes
KErrNotFoundBIO message type does not exist

GetBioIndexWithMsgIDL ( TUid, TInt & )

IMPORT_C voidGetBioIndexWithMsgIDL(TUidaMsgID,
TInt &rIndex
)

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

Parameters
aMsgIDBIO message type
rIndexOn return, index of found BIF
Leave Codes
KErrNotFoundNot found

GetBioMsgID ( TInt, TUid & )

IMPORT_C voidGetBioMsgID(TIntaIndex,
TUid &rMsgID
)

Gets the BIO message type for a specified index.

Parameters
aIndexIndex
rMsgIDOn return, BIO message type

GetBioParserName ( TInt )

IMPORT_C const TPtrCGetBioParserName(TIntaIndex)

Gets the BIO parser name for a specified index.

Parameters
aIndexIndex
Return Value
BIO parser name

GetBioParserNameL ( TUid )

IMPORT_C const TPtrCGetBioParserNameL(TUidaMsgID)

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

Parameters
aMsgIDBIO message type
Return Value
BIO parser name
Leave Codes
KErrNotFoundNot found

GetDefaultSendBearerByTypeL ( TUid, TBioMsgIdType, TBioMsgId & )

IMPORT_C voidGetDefaultSendBearerByTypeL(TUidaBioUID,
TBioMsgIdTypeaPortType,
TBioMsgId &rBioMsgIdentifier
)

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

Parameters
aBioUIDBIO message type
aPortTypeBearer type
rBioMsgIdentifierOn return, the default BIF ID entry
Leave Codes
KErrNotFoundNot found

GetDefaultSendBearerL ( TUid, TBioMsgId & )

IMPORT_C voidGetDefaultSendBearerL(TUidaBioUID,
TBioMsgId &rBioMsgIdentifier
)

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

Parameters
aBioUIDBIO message type
rBioMsgIdentifierOn return, the default BIF ID entry
Leave Codes
KErrNotFoundNot found

GetDefaultSendBearerTypeL ( TUid, TBioMsgIdType & )

IMPORT_C voidGetDefaultSendBearerTypeL(TUidaBioUID,
TBioMsgIdType &rPortType
)

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

Parameters
aBioUIDBIO message type
rPortTypeOn return, the bearer type
Leave Codes
KErrNotFoundNot found

GetFileExtL ( TUid )

IMPORT_C const TPtrCGetFileExtL(TUidaMsgID)

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

Parameters
aMsgIDBIO message type
Return Value
BIO file extension
Leave Codes
KErrNotFoundNot found

GetIdentifierTextL ( TUid, TBioMsgIdType, TBioMsgIdText & )

IMPORT_C voidGetIdentifierTextL(TUidaMsgID,
TBioMsgIdTypeaPortType,
TBioMsgIdText &aText
)

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

Parameters
aMsgIDBIO message type
aPortTypeBearer type
aTextOn return, the identifier text

GetPortNumberL ( TUid, TBioMsgIdType, TInt & )

IMPORT_C voidGetPortNumberL(TUidaMsgID,
TBioMsgIdTypeaPortType,
TInt &aPortNumber
)

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

Parameters
aMsgIDBIO message type
aPortTypeBearer type
aPortNumberOn return, the port number
Leave Codes
KErrNotFoundNot found

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

IMPORT_C TIntIsBioMessageL(TBioMsgIdTypeaPortType,
const TDesC &aPattern,
TUint16aPort,
TUid &rBioMsgUID
)

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

Parameters
aPortTypeBearer type
aPatternText identifier to match
aPortPort to match
rBioMsgUIDOn return, the matching BIO message type
Return Value
KErrNone if found, else KErrNotFound

IsBioMessageL ( TBioMsgId, TUid & )

IMPORT_C TIntIsBioMessageL(TBioMsgIdbioMessageData,
TUid &rBioMsgUID
)

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

Parameters
bioMessageDataBIF ID to match
rBioMsgUIDOn 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
afileSystemConnected 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
afileSystemConnected file system handle
Return Value
New BIO database object

RemoveBifL ( TUid )

IMPORT_C voidRemoveBifL(TUidaMsgID)

Removes a BIF specified by UID.

Parameters
aMsgIDBIO type UID

RemoveBifL ( TInt )

IMPORT_C voidRemoveBifL(TIntaIndex)

Removes a BIF specified by index.

Parameters
aIndexIndex of file in this object