CXmlEngSerializer Class Reference

#include <xml/dom/xmlengserializer.h>

Link against: xmlengineserializer.lib

class CXmlEngSerializer : public CBase

Inherits from

Public Member Functions
virtual ~CXmlEngSerializer()
IMPORT_C CXmlEngSerializer *NewL(TXmlEngSerializerType)
virtual IMPORT_C TIntSerializeL(const TXmlEngNode)
virtual IMPORT_C TIntSerializeL(const TDesC &, const TXmlEngNode, const TXmlEngSerializationOptions &)
virtual IMPORT_C TIntSerializeL(RFs &, const TDesC &, const TXmlEngNode, const TXmlEngSerializationOptions &)
virtual IMPORT_C TIntSerializeL(RBuf8 &, const TXmlEngNode, const TXmlEngSerializationOptions &)
IMPORT_C voidSetOutput(RBuf8 &)
IMPORT_C voidSetOutput(MXmlEngOutputStream &)
IMPORT_C voidSetOutputL(const TDesC &)
IMPORT_C voidSetSerializationOptions(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.

See also: TXmlEngSerializerType

Constructor & Destructor Documentation

~CXmlEngSerializer ( )

~CXmlEngSerializer()[virtual]

Destructor

Member Function Documentation

NewL ( TXmlEngSerializerType )

IMPORT_C CXmlEngSerializer *NewL(TXmlEngSerializerTypeaType = ESerializerDefault)[static]

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

Parameters
aTypeSerializer type
Return Value
The serializer
Leave Codes

SerializeL ( const TXmlEngNode )

IMPORT_C TIntSerializeL(const TXmlEngNodeaRoot =  TXmlEngNode())[virtual]

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

Parameters
aRootThe root node of the DOM tree to be serialized
Return Value
The number of bytes written
Leave Codes
KXmlEngErrNoParametersNo previous call to
KErrNotSupportedUnsupported serialization type
KXmlEngErrWrongEncodingEncoding not understood
KXmlEngErrWrongUseofAPIDocument of root node is NULL
KXmlEngErrNegativeOutputSizeThe data to be serialized has a negative size

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

IMPORT_C TIntSerializeL(const TDesC &aFileName,
const TXmlEngNodeaRoot =  TXmlEngNode(),
const TXmlEngSerializationOptions &aOptions =  TXmlEngSerializationOptions()
)[virtual]

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

Parameters
aFileNameThe file name to serialize to
aRootThe root node of the DOM tree to be serialized
aOptionsThe serialization options
Return Value
The number of bytes written
Leave Codes
KXmlEngErrWrongEncodingEncoding not understood
KXmlEngErrWrongUseofAPIDocument of root node is NULL
KXmlEngErrNegativeOutputSizeThe data to be serialized has a negative size

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

IMPORT_C TIntSerializeL(RFs &aRFs,
const TDesC &aFileName,
const TXmlEngNodeaRoot =  TXmlEngNode(),
const TXmlEngSerializationOptions &aOptions =  TXmlEngSerializationOptions()
)[virtual]

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

Parameters
aRFsFile Server session
aFileNameThe file name to serialize to
aRootThe root node of the DOM tree to be serialized
aOptionsThe serialization options
Return Value
The number of bytes written
Leave Codes
KXmlEngErrWrongEncodingEncoding not understood
KXmlEngErrWrongUseofAPIDocument of root node is NULL
KXmlEngErrNegativeOutputSizeThe data to be serialized has a negative size

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

IMPORT_C TIntSerializeL(RBuf8 &aBuffer,
const TXmlEngNodeaRoot =  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.

Parameters
aBufferThe buffer to serialize to
aRootThe root node of DOM tree
aOptionsThe serialization options
Return Value
The number of bytes written
Leave Codes
KXmlEngErrWrongEncodingEncoding not understood
KXmlEngErrWrongUseofAPIDocument of root node is NULL
KXmlEngErrNegativeOutputSizeThe data to be serialized has a negative size

SetOutput ( RBuf8 & )

IMPORT_C voidSetOutput(RBuf8 &aBuffer)

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

Parameters
aBufferThe buffer to serialize

SetOutput ( MXmlEngOutputStream & )

IMPORT_C voidSetOutput(MXmlEngOutputStream &aStream)

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

SetOutputL ( const TDesC & )

IMPORT_C voidSetOutputL(const TDesC &aFileName)
Sets the output type to file and saves the file name for later serialization.
Parameters
aFileNameThe file name of the file to serialize
Leave Codes

SetSerializationOptions ( TXmlEngSerializationOptions & )

IMPORT_C voidSetSerializationOptions(TXmlEngSerializationOptions &aOptions)

Sets the serialization options

Parameters
aOptionsThe serialization options to set. Ownership is not transferred and aOptions must stay in scope for the lifetime of the serializer.
© Nokia 2005.