Class RStringBase

class RStringBase;

Description

Base class for classes that represent a string in a string pool.

There are sub-classes for folded and non-folded strings. Use this class when you want to receive a string, but have no intention of comparing it with anything.

Members

Defined in RStringBase:
Close(), Copy(), DesC(), Index(), OriginalTableRef(), Pool(), RStringBase(), iPool, iVal, operator RStringTokenBase()

See also:

• RStringPool

inline RStringBase();

Description

Default constructor.

IMPORT_C void Close();

Description

Closes a string.

You must close every string you open. In other words, every call to RStringBase::Copy(), RStringPool::OpenStringL() and RStringPool::OpenFStringL() must be matched by a close.

Strings created through RStringPool::String() or RStringPool::StringF() with an integer argument need not be closed (but closing is harmless).

Strings created through RStringPool::String() or RStringPool::StringF() with a StringToken or StringTokenF argument must not be closed, as they're just changing the external representation.

IMPORT_C RStringBase Copy();

Description

Copies a string.

Both the original and the copy string must be separately closed.

Return value

RStringBase The string base.

IMPORT_C const TDesC8 &DesC() const;

Description

Gets the content of the string.

Return value

const TDesC8 & Descriptor containing the content of the string.

inline operator RStringTokenBase() const;

Description

Returns a compact string equivalent to the string

Return value

IMPORT_C TInt Index(const TStringTable &aTable) const;

Description

Gets the enumeration value corresponding to this string.

Parameters

const TStringTable &aTable String table to look in

Return value

TInt The string's enumeration value, or -1 if there is no such value

Panic codes

EStringTableNotFound If the table supplied is not found. This panic is raised in debug builds only, in release mode the behaviour is undefined

IMPORT_C const TStringTable *OriginalTableRef() const;

Description

Gets the table (if any) that first added the current string to the pool.

Note there multiple tables can contain the same string.

Return value

const TStringTable * The table or NULL if the string was created dynamically (not from a table)

inline RStringPool Pool() const;

Description

Gets the string pool.

Return value

RStringPool The string pool.

protected: RStringPool iPool;

Description

protected: TUint32 iVal;

Description