Class CBioInfoFileReader

class CBioInfoFileReader : public CBioInfoFile;

Description

BIO information file (BIF) reader.

Allows reading (all but the icons) from an existing BIF file.

Derivation

• CBioInfoFile - No description.

• CBioInfoFileReader - BIO information file (BIF) reader

Members

Defined in CBioInfoFileReader:
Description(), FileExtension(), GeneralData1(), GeneralData2(), GeneralData3(), IconsFilename(), IdsLC(), MessageAppCtrlName(), MessageAppCtrlUid(), MessageAppUid(), MessageParserName(), MessageTypeUid(), NewL(), NewLC(), ZoomLevelsCount(), ZoomLevelsLC(), ~CBioInfoFileReader()

static IMPORT_C CBioInfoFileReader *NewLC(RFs &aFs, const TDesC &aFileName, TUid aMsgTypeUid=TUid::Null());

Description

Allocates and constructs a new BIF reader object, leaving the object on the cleanup stack.

It loads the specified BIF file.

Parameters

RFs &aFs Connected file handle const TDesC &aFileName BIF file name TUid aMsgTypeUid Optional message type UID. If this is specified, and the file does not does not describe this type, then it leaves with KErrCorrupt.

Return value

CBioInfoFileReader * New BIF reader object

static IMPORT_C CBioInfoFileReader *NewL(RFs &aFs, const TDesC &aFileName, TUid aMsgTypeUid=TUid::Null());

Description

Allocates and constructs a new BIF reader object.

It loads the specified BIF file.

Parameters

RFs &aFs Connected file handle const TDesC &aFileName BIF file name TUid aMsgTypeUid Optional message type UID. If this is specified, and the file does not does not describe this type, then it leaves with KErrCorrupt.

Return value

CBioInfoFileReader * New BIF reader object

virtual IMPORT_C ~CBioInfoFileReader();

Description

Destructor.

IMPORT_C TUid MessageTypeUid() const;

Description

Gets the BIF's message type UID setting.

Return value

TUid Message type UID

IMPORT_C const TPtrC MessageParserName() const;

Description

Gets the BIF's message parser name.

Return value

const TPtrC BIF's message parser name

IMPORT_C TUid MessageAppUid() const;

Description

Gets the BIF's application UID setting.

Return value

TUid Application UID setting

IMPORT_C TUid MessageAppCtrlUid() const;

Description

Deprecated method.

Use CBioInfoFileReader::MessageAppCtrlName

Return value

TUid Invalid return.

IMPORT_C const TPtrC MessageAppCtrlName() const;

Description

Gets the BIF's control name.

Return value

const TPtrC Control name

IMPORT_C TInt16 GeneralData1() const;

Description

Gets the BIF's general data 1 setting.

Return value

TInt16 General data 1 setting

IMPORT_C TInt16 GeneralData2() const;

Description

Gets the BIF's general data 2 setting.

Return value

TInt16 General data 2 setting

IMPORT_C TInt16 GeneralData3() const;

Description

Gets the BIF's general data 3 setting.

Return value

TInt16 General data 3 setting

IMPORT_C const TPtrC Description() const;

Description

Gets the BIF's description setting.

Return value

const TPtrC BIF's description setting

IMPORT_C const TPtrC FileExtension() const;

Description

Gets the BIF's file extension setting.

Return value

const TPtrC BIF's file extension setting

IMPORT_C const TPtrC IconsFilename() const;

Description

Gets the BIF's icons filename setting.

Return value

const TPtrC BIF's icons filename setting

IMPORT_C const CArrayFixFlat< TInt16 > *ZoomLevelsLC() const;

Description

Gets the BIF's icon zoom levels setting.

The array of icon zoom level settings is left of the cleanup stack and ownership is returned to the caller.

Return value

const CArrayFixFlat< TInt16 > * Icon zoom levels setting

IMPORT_C TInt ZoomLevelsCount() const;

Description

Gets the BIF's number of icon zoom levels.

Return value

TInt Number of icon zoom levels

IMPORT_C const CArrayFixFlat< TBioMsgId > *IdsLC() const;

Description

Gets the BIF's ID array.

The of IDs is left of the cleanup stack and ownership is returned to the caller.

Return value

const CArrayFixFlat< TBioMsgId > * ID array