RStringPool Class Reference

#include <stringpool.h>

class RStringPool

Public Member Functions
	RStringPool()
IMPORT_C void	Close()
IMPORT_C RStringF	OpenFStringL(const TDesC8 &)
IMPORT_C void	OpenL()
IMPORT_C void	OpenL(const TStringTable &)
IMPORT_C void	OpenL(const TStringTable &, MStringPoolCloseCallBack &)
IMPORT_C RString	OpenStringL(const TDesC8 &)
IMPORT_C RString	String(RStringToken)
IMPORT_C RString	String(TInt, const TStringTable &)
IMPORT_C RStringF	StringF(RStringTokenF)
IMPORT_C RStringF	StringF(TInt, const TStringTable &)

Detailed Description

The string pool handle object. A string pool can have several distinct handles associated with it, each associated with a different pre-loaded table. The difference between them is that creating a string from an enum will interpret the enum as an offset into the relevant pre-loaded table String pool handle.

A string pool can have several distinct handles associated with it, each associated with a different pre-loaded table. Creating a string from an enum value interprets the value as an offset into the relevant pre-loaded table.

Constructor & Destructor Documentation

RStringPool ( )

RStringPool

(

)

[inline]

Default constructor.

Member Function Documentation

Close ( )

IMPORT_C void

(

)

Closes the string pool table.

This invalidates all other handles to the table.

OpenFStringL ( const TDesC8 & )

IMPORT_C RStringF

OpenFStringL

(

const TDesC8 &

aString

)

const

Creates an RStringF using the current string pool.

The string is opened as case-insensitive.

leave: KErrNoMemory Not enough memory to open the string

Parameter	Description
aString	The value of the string.

Returns: Initialised RStringF object

OpenL ( )

IMPORT_C void

OpenL

(

)

Implementation of RStringPool class Creates an initialised string pool with no pre-loaded string tables.

leave: KErrNoMemory Not enough memory to open the pool

OpenL ( const TStringTable & )

IMPORT_C void

OpenL

(

const TStringTable &

aTable

)

Creates an initialised string pool with a pre-loaded string table.

leave: KErrNoMemory Not enough memory to open the pool

Parameter	Description
aTable	The pre-loaded string table.

OpenL ( const TStringTable &, MStringPoolCloseCallBack & )

IMPORT_C void	OpenL	(	const TStringTable &	aTable,
			MStringPoolCloseCallBack &	aCallBack
		)

Creates an initialised string pool with a pre-loaded string table, and a string-pool-closing callback.

leave: KErrNoMemory Not enough memory to open the pool

Parameter	Description
aTable	The pre-loaded string table.
aCallBack	Callback interface that is called when the string pool closes

OpenStringL ( const TDesC8 & )

IMPORT_C RString

OpenStringL

(

const TDesC8 &

aString

)

const

Creates an RString using the current string pool.

The string is opened as case-sensitive.

leave: KErrNoMemory Not enough memory to open the string

Parameter	Description
aString	The value of the string.

Returns: Initialised RString object

String ( RStringToken )

IMPORT_C RString

String

(

RStringToken

aString

)

const

Creates an RString from the supplied RStringToken.

Parameter	Description
aString	The string token

Returns: Initialised RString object

String ( TInt, const TStringTable & )

IMPORT_C RString	String	(	TInt	aIndex,
			const TStringTable &	aTable
		)	const

Gets a case-sensitive string specified by a string table enumeration value.

aIndex is interpreted as an offset into the handle's pre-loaded string table.

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

Parameter	Description
aIndex	The string table enumeration value
aTable	The string table from which to read the string

Returns: Initialised RString object

StringF ( RStringTokenF )

IMPORT_C RStringF

StringF

(

RStringTokenF

aString

)

const

Creates a RStringF from the supplied RStringToken.

Parameter	Description
aString	The value of the string

Returns: Initialised RStringF object

StringF ( TInt, const TStringTable & )

IMPORT_C RStringF	StringF	(	TInt	aIndex,
			const TStringTable &	aTable
		)	const

Gets a case-insensitive string specified by a string table enumeration value.

Creates an RStringF from a string table enumeration value.

aIndex is interpreted as an offset into the handle's pre-loaded string table.

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

Parameter	Description
aIndex	The string table enumeration value
aTable	The string table from which to read the string

Returns: Initialised RStringF object