Class Xml::RStringDictionaryCollection

class RStringDictionaryCollection;

Description

The Xml::RStringDictionaryCollection class holds a collection of Dictionaries requested by the user.

Members

Defined in Xml::RStringDictionaryCollection:

• Close()This method cleans up the object before destruction. It releases all resources i...
• CurrentDictionaryL()constThis method obtains the current string dictionary in use. Also, serves as a way ...
• OpenDictionaryL(const TDesC8 &)This method loads the Dictionary.
• OpenL()This method opens this resource incrementing the reference count. It must be the...
• RStringDictionaryCollection()Default constructor
• StringPool()This method obtains a handle to the RStringPool

IMPORT_C RStringDictionaryCollection();

Description

Default constructor

Post-Condition

This object is properly constructed.

IMPORT_C void OpenL();

Description

This method opens this resource incrementing the reference count. It must be the first method called after construction.

Post-Condition

The object is ready to be used.

IMPORT_C void Close();

Description

This method cleans up the object before destruction. It releases all resources in accordance to the R Class pattern.

Post-Condition

This object may be allowed to go out of scope.

IMPORT_C void OpenDictionaryL(const TDesC8 &aDictionaryDescription);

Pre-Condition

Connect has been called.

Description

This method loads the Dictionary.

Post-Condition

The Dictionary has been loaded.

Parameters

const TDesC8 &aDictionaryDescription The Namepspace MIME type.

IMPORT_C RStringPool& StringPool();

Description

This method obtains a handle to the RStringPool

Return value

RStringPool & the RStringPool

IMPORT_C MStringDictionary& CurrentDictionaryL() const;

Description

This method obtains the current string dictionary in use. Also, serves as a way to test if any dictionaries have been loaded as none needs be.

Return value

Xml::MStringDictionary & the current Dictionary in use, if any.

Leave codes

KErrXmlMissingStringDictionary if there is no dictionary