Class Xml::CMatchData

class CMatchData : public CBase;

Description

Xml::CMatchData class provides detailed parser information for XML framework. Client application should use this class to precisely specify the plugin, which should be used as a parsing engine in XML framework.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• Xml::CMatchData - ...

Members

Defined in Xml::CMatchData:

• MimeType()constReturns a pointer to the mime type string.
• NewL()Creates Xml::CMatchData object with its default values.
• NewLC()Creates Xml::CMatchData object with its default values. Leaves an obeject pointe...
• SetCaseSensitivity(TBool)Sets the Case Sensitivity flag. Customized resolver uses this setting to turn on...
• SetLeaveOnMany(TBool)Sets the LeaveOnManyFlag flag. If set, it notifies customized resolver it should...
• SetMimeTypeL(const TDesC8 &)Sets up a mime type attribute to a string given as an aData descriptor.
• SetRomOnly(TBool)Sets the Rom Only flag. If set, it notifies customized resolver the request is f...
• SetVariantL(const TDesC8 &)Sets up a variant attribute to a string given as an aVariant descriptor. If this...
• Variant()constReturns a pointer to the variant string.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Related Topics

 » Symbian OS v9.4 » Examples » System Library example code » XmlExample: Using XML framework to parse an XML file

• XmlExample: Using the XML framework to parse an XML file » Class summary

IMPORT_C static CMatchData* NewL();

Description

Creates Xml::CMatchData object with its default values.

Return value

Xml::CMatchData * A pointer to the newly created Xml::CMatchData object.

Leave codes

KErrNoMemory If there is not enough memory to create an object.

IMPORT_C static CMatchData* NewLC();

Description

Creates Xml::CMatchData object with its default values. Leaves an obeject pointer on a cleanup stack.

Return value

Xml::CMatchData * A pointer to the newly created Xml::CMatchData object.

Leave codes

KErrNoMemory If there is not enough memory

IMPORT_C void SetMimeTypeL(const TDesC8 &aData);

Description

Sets up a mime type attribute to a string given as an aData descriptor.

Parameters

const TDesC8 &aData String descriptor

Leave codes

KErrNoMemory If there is not enough memory for new string allocation. KErrArgument If passed descriptor doesn't comply with length constraints.

IMPORT_C const TPtrC8 MimeType() const;

Description

Returns a pointer to the mime type string.

Return value

const TPtrC8 A pointer to the mime type string. Pointer to KNullDesC8 is returned if not set up yet.

IMPORT_C void SetVariantL(const TDesC8 &aVariant);

Description

Sets up a variant attribute to a string given as an aVariant descriptor. If this is not set OR is set to a string of length 0 the Variant ID is not used during parser resolution and hence the variant IDs of plug-in parsers are ignored.

Parameters

const TDesC8 &aVariant

Leave codes

KErrNoMemory If there is not enough memory for new string allocation. KErrArgument If passed descriptor doesn't comply with length constraints.

IMPORT_C const TPtrC8 Variant() const;

Description

Returns a pointer to the variant string.

Return value

const TPtrC8 A pointer to the variant string. Pointer to KNullDesC8 is returned if not set up yet.

IMPORT_C void SetLeaveOnMany(TBool aSetting);

Description

Sets the LeaveOnManyFlag flag. If set, it notifies customized resolver it should leave when the query is resolved to more than one parser. By default this flag is not set, so the framework chooses a parser in this case.

Parameters

TBool aSetting The setting value.

IMPORT_C void SetRomOnly(TBool aSetting);

Description

Sets the Rom Only flag. If set, it notifies customized resolver the request is for ROM-based parsers only. By default this flag is not set, so the framework searches for rom and non-rom based parsers.

Parameters

TBool aSetting The setting value.

IMPORT_C void SetCaseSensitivity(TBool aSetting);

Description

Sets the Case Sensitivity flag. Customized resolver uses this setting to turn on or off case sensitivity for strings matching.

Parameters

TBool aSetting The setting value.