CPlainText::TImportExportParam Class Reference

class CPlainText::TImportExportParam

Parameters for importing or exporting text using CPlainText::ImportTextL() or CPlainText::ExportTextL().

Constructor & Destructor Documentation

TImportExportParam()

TImportExportParam()[inline]

Default constructor. All member data is assigned default values. For details, see the member data.

Member Data Documentation

RFs * iFileSession

RFs *iFileSession

If non-null, a connected file server session used to load character conversion data. Only relevant if the text needs to be converted to or from Unicode. By default, null.

TUint iForeignEncoding

TUint iForeignEncoding

The identifier of the foreign character set encoding to be used to convert from or to.

Not used if iGuessForeignEncoding is true. If conversion to/from iForeignEncoding is not available on the phone, the function leaves with KErrNotSupported. By default, zero.

TBool iGuessForeignEncoding

TBool iGuessForeignEncoding

If ETrue, an attempt is made to guess the encoding of the foreign text being imported before converting it into Unicode. Used in CPlainText::ImportTextL(). If EFalse, the value specified in iForeignEncoding (if any) is used. If none of the available character conversion plug-ins on the phone return a confidence level greater than 50%, CPlainText::ImportTextL() leaves with KErrNotSupported. By default, false.

TBool iInputInternal

TBool iInputInternal

If ETrue, input is in internal format, so is read according to native endianness. Used in CPlainText::ImportTextL(). By default, EFalse.

TInt iMaxInputChars

TInt iMaxInputChars

The maximum number of characters to read from the stream (when importing) or to read from the text object (when exporting). By default, KMaxTInt.

TInt iMaxLineLength

TInt iMaxLineLength

The wrap width as a number of characters.

Only relevant when exporting by line, (iOrganisation is CPlainText::EOrganiseByLine). Not used in CPlainText::ImportTextL(). By default, KMaxTInt.

TInt iMaxOutputChars

TInt iMaxOutputChars

The maximum number of characters to write to the stream (when exporting) or to write to the text object (when importing). By default, KMaxTInt.

TTextOrganisation iOrganisation

TTextOrganisation iOrganisation

Controls how line delimiters are translated. By default, EOrganiseByParagraph.

CPlainText::TTextOrganisation

TBool iOutputInternal

TBool iOutputInternal

If ETrue, output is in internal format, so is written according to native endianness. Used in CPlainText::ExportTextL(). By default, EFalse.

TUint iReserved

TUint iReserved