CXmlEngSerializer Class Reference

#include <xml/dom/xmlengserializer.h>

Link against: xmlengineserializer.lib

class CXmlEngSerializer : public CBase

Inherits from

CXmlEngSerializer

Public Member Functions
virtual	~CXmlEngSerializer()
IMPORT_C CXmlEngSerializer *	NewL(TXmlEngSerializerType)
virtual IMPORT_C TInt	SerializeL(const TXmlEngNode)
virtual IMPORT_C TInt	SerializeL(const TDesC &, const TXmlEngNode, const TXmlEngSerializationOptions &)
virtual IMPORT_C TInt	SerializeL(RFs &, const TDesC &, const TXmlEngNode, const TXmlEngSerializationOptions &)
virtual IMPORT_C TInt	SerializeL(RBuf8 &, const TXmlEngNode, const TXmlEngSerializationOptions &)
IMPORT_C void	SetOutput(RBuf8 &)
IMPORT_C void	SetOutput(MXmlEngOutputStream &)
IMPORT_C void	SetOutputL(const TDesC &)
IMPORT_C void	SetSerializationOptions(TXmlEngSerializationOptions &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Provides the serializer interface and provides common functionality to all serializers. Implements default serialization (plain XML). Derived classes implement serialization to other formats.

Constructor & Destructor Documentation

~CXmlEngSerializer ( )

~CXmlEngSerializer

(

)

[virtual]

Destructor

Member Function Documentation

NewL ( TXmlEngSerializerType )

IMPORT_C CXmlEngSerializer *

NewL

(

TXmlEngSerializerType

aType = ESerializerDefault

)

[static]

Creates a serializer of the given type. Returns an instance of this class or a derived class.

leave

One of the system-wide error codes

Parameter	Description
aType	Serializer type

Returns: The serializer

SerializeL ( const TXmlEngNode )

IMPORT_C TInt

SerializeL

(

const TXmlEngNode

aRoot = TXmlEngNode()

)

[virtual]

Serializes a DOM tree to the buffer, file or stream set previously with SetOutputL() or SetOutput().

leave: KXmlEngErrNoParameters No previous call to SetOutputL() or SetOutput().

leave: KErrNotSupported Unsupported serialization type

leave: KXmlEngErrWrongEncoding Encoding not understood

leave: KXmlEngErrWrongUseofAPI Document of root node is NULL

leave: KXmlEngErrNegativeOutputSize The data to be serialized has a negative size

leave

One of the system-wide error codes

Parameter	Description
aRoot	The root node of the DOM tree to be serialized

Returns: The number of bytes written

SerializeL ( const TDesC &, const TXmlEngNode, const TXmlEngSerializationOptions & )

IMPORT_C TInt	SerializeL	(	const TDesC &	aFileName,
			const TXmlEngNode	aRoot = TXmlEngNode(),
			const TXmlEngSerializationOptions &	aOptions = TXmlEngSerializationOptions()
		)	[virtual]

Serializes a DOM tree to file. Any filename previously set with SetOutputL(const TDesC&) is ignored.

leave: KXmlEngErrWrongEncoding Encoding not understood

leave: KXmlEngErrWrongUseofAPI Document of root node is NULL

leave: KXmlEngErrNegativeOutputSize The data to be serialized has a negative size

leave

One of the system-wide error codes

Parameter	Description
aFileName	The file name to serialize to
aRoot	The root node of the DOM tree to be serialized
aOptions	The serialization options

Returns: The number of bytes written

SerializeL ( RFs &, const TDesC &, const TXmlEngNode, const TXmlEngSerializationOptions & )

IMPORT_C TInt	SerializeL	(	RFs &	aRFs,
			const TDesC &	aFileName,
			const TXmlEngNode	aRoot = TXmlEngNode(),
			const TXmlEngSerializationOptions &	aOptions = TXmlEngSerializationOptions()
		)	[virtual]

Serializes a DOM tree to file. Any filename previously set with SetOutputL(const TDesC&) is ignored.

leave: KXmlEngErrWrongEncoding Encoding not understood

leave: KXmlEngErrWrongUseofAPI Document of root node is NULL

leave: KXmlEngErrNegativeOutputSize The data to be serialized has a negative size

leave

One of the system-wide error codes

Parameter	Description
aRFs	File Server session
aFileName	The file name to serialize to
aRoot	The root node of the DOM tree to be serialized
aOptions	The serialization options

Returns: The number of bytes written

SerializeL ( RBuf8 &, const TXmlEngNode, const TXmlEngSerializationOptions & )

IMPORT_C TInt	SerializeL	(	RBuf8 &	aBuffer,
			const TXmlEngNode	aRoot = TXmlEngNode(),
			const TXmlEngSerializationOptions &	aOptions = TXmlEngSerializationOptions()
		)	[virtual]

Serializes a DOM tree to buffer. Any buffer previously set with SetOutputL(RBuf8&) is ignored. Any existing data in aBuffer is destroyed. This function allocates memory for the buffer and the caller must close the buffer when finished.

leave: KXmlEngErrWrongEncoding Encoding not understood

leave: KXmlEngErrWrongUseofAPI Document of root node is NULL

leave: KXmlEngErrNegativeOutputSize The data to be serialized has a negative size

leave

One of the system-wide error codes

Parameter	Description
aBuffer	The buffer to serialize to
aRoot	The root node of DOM tree
aOptions	The serialization options

Returns: The number of bytes written

SetOutput ( RBuf8 & )

IMPORT_C void

SetOutput

(

RBuf8 &

aBuffer

)

Sets the output type to buffer and saves the buffer for later serialization.

Parameter	Description
aBuffer	The buffer to serialize

SetOutput ( MXmlEngOutputStream & )

IMPORT_C void

SetOutput

(

MXmlEngOutputStream &

aStream

)

Sets the output type to stream and saves the stream for later serialization.

SetOutputL ( const TDesC & )

IMPORT_C void

SetOutputL

(

const TDesC &

aFileName

)

Sets the output type to file and saves the file name for later serialization.

leave

One of the system-wide error codes

Parameter	Description
aFileName	The file name of the file to serialize

SetSerializationOptions ( TXmlEngSerializationOptions & )

IMPORT_C void

SetSerializationOptions

(

TXmlEngSerializationOptions &

aOptions

)

Sets the serialization options

Parameter	Description
aOptions	The serialization options to set. Ownership is not transferred and aOptions must stay in scope for the lifetime of the serializer.