Xml::RStringDictionaryCollection Class Reference

#include <xml/stringdictionarycollection.h>

Link against: xmlframework.lib

class Xml::RStringDictionaryCollection

Public Member Functions
	RStringDictionaryCollection()
IMPORT_C void	Close()
IMPORT_C MStringDictionary &	CurrentDictionaryL()
IMPORT_C void	OpenDictionaryL(const TDesC8 &)
IMPORT_C void	OpenL()
IMPORT_C RStringPool &	StringPool()

Detailed Description

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

Constructor & Destructor Documentation

RStringDictionaryCollection ( )

IMPORT_C

RStringDictionaryCollection

(

)

Default constructor

Post-condition: This object is properly constructed.

Member Function Documentation

Close ( )

IMPORT_C void

(

)

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.

CurrentDictionaryL ( )

IMPORT_C MStringDictionary &

CurrentDictionaryL

(

)

const

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: the current Dictionary in use, if any.

Leave Codes
KErrXmlMissingStringDictionary	if there is no dictionary

OpenDictionaryL ( const TDesC8 & )

IMPORT_C void

OpenDictionaryL

(

const TDesC8 &

aDictionaryDescription

)

This method loads the Dictionary.

Pre-condition: Connect has been called.

Post-condition: The Dictionary has been loaded.

Parameters
aDictionaryDescription	The Namepspace MIME type.

OpenL ( )

IMPORT_C void

OpenL

(

)

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.

StringPool ( )

IMPORT_C RStringPool &

StringPool

(

)

This method obtains a handle to the RStringPool

Return Value: the RStringPool