#include <mw/biodb.h>
Link against: biodb.lib
class CBIODatabase : public CBase, public CBase |
Public Member Enumerations | |
---|---|
enum | TSearchList { EStart, ENext } |
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
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 |
IMPORT_C void | AddBifL | ( | CBioInfoFileReader * | aBifReader | ) |
Adds a specified BIF.
IMPORT_C const CBioInfoFileReader & | BifReader | ( | TInt | aIndex | ) | const |
Gets a BIF reader for a BIF at a specified index.
Parameters | |
---|---|
aIndex | Index |
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 |
Depreacated method.
Need to use CBIODatabase::GetBioControlName instead.
See also: CBIODatabase::GetBioControlName
Parameters | |
---|---|
aIndex | Not used |
rControlID | Not used |
Panic Codes | |
---|---|
USER | EInvariantFalse |
Depreacated method.
Need to use CBIODatabase::GetBioControlNameL instead.
See also: CBIODatabase::GetBioControlNameL
Parameters | |
---|---|
rControlID | Not used |
Panic Codes | |
---|---|
USER | EInvariantFalse |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
IMPORT_C void | RemoveBifL | ( | TInt | aIndex | ) |
Removes a BIF specified by index.
Parameters | |
---|---|
aIndex | Index of file in this object |