Symbian
Symbian Developer Library

SYMBIAN OS V9.4

Feedback

[Index] [Previous] [Next]

#include <DAMIMPOR.H>
Link against: damodl.lib
This item is not part of the S60 5th Edition SDK

Class CDaFileImporter

Interface status: deprecated

class CDaFileImporter : public CDaIncremental;

Description

Base class for classes that import a file into a data application model.

Derivation

Members

Defined in CDaFileImporter:

Inherited from CBase:

Inherited from CDaIncremental:


Construction and destruction


CDaFileImporter(TDaFileImportParams const &)

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C CDaFileImporter(TDaFileImportParams const &aParams);

Description

Constructor.

Parameters

TDaFileImportParams const &aParams

Import parameters


~CDaFileImporter()

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C ~CDaFileImporter();

Description

Destructor.

[Top]


Member functions


OpenL()

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C void OpenL();

Description

Opens the database to which to import.


CloseL()

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C virtual void CloseL();

Description

Closes the database.


ImportL()

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C virtual TInt ImportL();

Description

Begins the data importation.

This calls CDaFileImporter::Next(TInt &) until that function says that there are no remaining steps.

Return value

TInt

System wide error code


Next(TInt &)

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C virtual TInt Next(TInt &aRemainingSteps);

Description

Interface to performing an incremental step in data importation.

The default implementation simply calls CDaFileImporter::DoNext(TInt &).

Parameters

TInt &aRemainingSteps

On return, number of remaining steps

Return value

TInt

System wide error code


DoNext(TInt &)

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C virtual TInt DoNext(TInt &);

Description

Implements an incremental step in data importation.

The default implementation simply returns KErrGeneral.

Parameters

TInt &

Return value

TInt

System wide error code.


HandleLeave(TInt)

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C virtual void HandleLeave(TInt aError);

Description

Utility function to handle a leave occurring in data importation.

It calls the object's active object cancel function.

Parameters

TInt aError

System wide error code


HandleCancel()

Interface status: deprecated Inherited from: CDaFileImporter

IMPORT_C virtual void HandleCancel();

Description

Utility function to handle a cancel event occurring in data importation.

It calls the object's active object cancel function.

[Top]


Member enumerations


Enum TState

Interface status: deprecated

protected: TState

Description

Import operation states.

EBeforeStartOfToken

Read position is before the start of an input field.

EReadingToken

Input field is being read.

EEndOfFile

End of import file.

EStartOfFile

Start of import file.

[Top]


Member data


iParams

Interface status: deprecated Inherited from: CDaFileImporter

protected: TDaFileImportParams iParams;

Description

Import parameters set on construction.


iFs

Interface status: deprecated Inherited from: CDaFileImporter

protected: RFs iFs;

Description

File server handle.


iFile

Interface status: deprecated Inherited from: CDaFileImporter

protected: RFileBuf iFile;

Description

Handle to import file.


iState

Interface status: deprecated Inherited from: CDaFileImporter

protected: TState iState;

Description

Import operation state.


iRow

Interface status: deprecated Inherited from: CDaFileImporter

protected: CDaRow * iRow;

Description

Row pointer.


iLineBuffer

Interface status: deprecated Inherited from: CDaFileImporter

protected: CBufFlat * iLineBuffer;

Description

Input line buffer.


iColumnBuffer

Interface status: deprecated Inherited from: CDaFileImporter

protected: CBufFlat * iColumnBuffer;

Description

Column import buffer.


iRecNo

Interface status: deprecated Inherited from: CDaFileImporter

protected: TInt iRecNo;

Description

Number of records imported.


iTotalBytesRead

Interface status: deprecated Inherited from: CDaFileImporter

protected: TInt iTotalBytesRead;

Description

Number of bytes imported.


iFileSize

Interface status: deprecated Inherited from: CDaFileImporter

protected: TInt iFileSize;

Description

Import file size.