CSenXmlReader Class Reference

Destructor.

C++ constructor.

Symbian 2nd phase constructor.

Parameters:

aParserMimeType

sets the MIME type of this XML parser.

Method for checking which feature has been enabled in the parser.

Since:

Series60 3.0

Returns:

the corresponding integer id of the feature

This method obtains the interface matching the specified UID.

Since:

Series60 3.0

Parameters:

aUid

the UID identifying the required interface.

Returns:

NULL if no interface matching the UID is found or if content handler was not set. Otherwise, returns pointer to the interface.

A constructor with parser MIME type and parser feature enabling.

Since:

Series60 3.0

Parameters:

aParserFeature

is typically some enumeration introduced in Xml::TParserFeature or some other feature introduced in some XML parser implementation. Leave codes: KErrArgument if aParserFeature value is negative.

A constructor with parser MIME type.

Standard two-phase constructor.

Since:

Series60 3.0

Parameters:

aParserMimeType

is the XML parser MIME type. If descriptor is of zero-length, then default MIME type KXmlParserMimeType is used ("text/xml"). Availability of other MIME types depends on underlying parser implementation.

Returns:

pointer to a new CSenXmlReader instance.

A constructor with parser feature enabling.

Uses default parser MIME type "text/xml" (KXmlParserMimeType).

Since:

Series60 3.0

Parameters:

aParserFeature

is typically some enumeration introduced in Xml::TParserFeature or some other feature introduced in some XML parser implementation. Leave codes: KErrArgument if aParserFeature value is negative.

Standard two-phase constructor.

Creates new parser instance using default MIME type "text/xml" (KXmlParserMimeType).

Since:

Series60 3.0

Returns:

pointer to a new CSenXmlReader instance.

A constructor with parser MIME type and parser feature enabling.

Since:

Series60 3.0

Parameters:

	aParserMimeType	is the XML parser MIME type. If descriptor is of zero-length, then default MIME type KXmlParserMimeType is used ("text/xml"). Availability of other MIME types depends on underlying parser implementation.
	aParserFeature	is typically some enumeration introduced in Xml::TParserFeature or some other feature introduced in some XML parser implementation. Leave codes: KErrArgument if aParserFeature value is negative.

A constructor with parser MIME type.

Since:

Series60 3.0

Parameters:

aParserMimeType

is the XML parser MIME type. If descriptor is of zero-length, then default MIME type KXmlParserMimeType is used ("text/xml"). Availability of other MIME types depends on underlying parser implementation.

Returns:

pointer to a new CSenXmlReader instance which is left on cleanup stack.

A constructor with parser feature enabling.

Uses default parser MIME type "text/xml" (KXmlParserMimeType).

Since:

Series60 3.0

Parameters:

	aParserMimeType	is the XML parser MIME type. If descriptor is of zero-length, then default MIME type KXmlParserMimeType is used ("text/xml"). Availability of other MIME types depends on underlying parser implementation.
	aParserFeature	is typically some enumeration introduced in Xml::TParserFeature or some other feature introduced in some XML parser implementation. Leave codes: KErrArgument if aParserFeature value is negative.

Standard two-phase constructor.

Creates new parser instance using default MIME type "text/xml" (KXmlParserMimeType).

Since:

Series60 3.0

Returns:

pointer to a new CSenXmlReader instance which is left on cleanup stack.

Since:

Series60 3.0

Parameters:

	aBytes	is the actual XML data, content in UTF-8 form
	aErrorCode	KErrNone, or some system-wide error code if an error has occured.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

OnError is a callback method signalled by Symbian XML framework.

Current implementation of this class issues a leave in original ParseL() call on any received by this callback implementation. Used leave code will be the received error code.

Since:

Series60 3.0

Parameters:

aErrorCode

is one of the Symbian XML framework errors listed in XmlFrameworkErrors.h

If content handler was not set, ParseL will leaves with KErrSenXmlContentHandlerNotSet.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Since:

Series60 3.0 Leave codes: KErrSenXmlContentHandlerNotSet if XML content handler for this XML reader has not been set. This leave can be avoided calling SetContentHandlerL() method prior parsing some XML document.

Parse an XML document.

Since:

Series60 3.0

Parameters:

	aRFs	An open filesession.
	aFileToParse	Filename of file to parse.

Parse an XML buffer.

Since:

Series60 3.0

Parameters:

aBuff

Buffer containing document to parse. Note that this method will also leave, if an error is returned from Symbian XML framework. Here are the corresponding enums, and their respective error code values (-1000, -999... and up) (XML-specific errors returned by the XML parser) [from XmlParserErrors.h] EXmlParserError = -1000, EXmlSyntax = 2+EXmlParserError, // -998 EXmlNoElements, // -997 EXmlInvalidToken, // -996 EXmlUnclosedToken, // -995 EXmlPartialChar, // -994 EXmlTagMismatch, // -993 EXmlDuplicateAttribute, // -992 EXmlJunkAfterDocElement, // -991 EXmlPeRef, // -990 EXmlUndefinedEntity, // -989 EXmlRecursiveEntity, // -988 EXmlAsyncEntity, // -987 EXmlBadCharRef, // -986 EXmlBinaryEntityRef, // -985 EXmlAttributeExternalEntityRef, // -984 EXmlMisplacedPi, // -983 EXmlUnknownEncoding, // -982 EXmlIncorrectEncoding, // -981 EXmlUnclosedCdata, // -980 EXmlExternalEntityHandling, // -979 EXmlNotStandalone, // -978 EXmlUnexpectedState, // -977 EXmlEntityDeclInPe, // -976 EXmlDtdRequired, // -975 EXmlFeatureLockedWhileParsing // -974

Deprecated:

• use EnabledParserFeature() instead.

This method re-initializes encapsulated CParser class instance.

Since:

Series60 3.0

Method to allow client to register a content event handler (for XML) for the current reader.

Since:

Series60 3.0

Parameters:

aContentHandler

The new event handler.

Method for enabling a parser feature.

Since:

Series60 3.0

Parameters:

aParserFeature

is typically some enumeration introduced in Xml::TParserFeature or some other feature introduced in some XML parser implementation.

Returns:

KErrNone or some system-wide error code, if an error has occurred.