epoc32/include/xml/dom/xmlengdataserializer.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
// Interface class describing class that may be used as
williamr@4
    15
// serializer for binary data
williamr@4
    16
//
williamr@2
    17
williamr@2
    18
williamr@2
    19
williamr@2
    20
/**
williamr@4
    21
 @file
williamr@4
    22
 @publishedAll
williamr@4
    23
 @released
williamr@4
    24
*/
williamr@4
    25
#ifndef XMLENGMDATASERIALIZER_H
williamr@4
    26
#define XMLENGMDATASERIALIZER_H
williamr@4
    27
williamr@4
    28
#include <xml/dom/xmlengnode.h>
williamr@4
    29
williamr@4
    30
/**
williamr@4
    31
This interface is used to serialize binary data stored in a node, external
williamr@4
    32
memory chunk (RChunk) or file.  This interface may be implemented by client
williamr@4
    33
applications.
williamr@4
    34
@see TXmlEngSerializationOptions
williamr@4
    35
*/
williamr@2
    36
class MXmlEngDataSerializer
williamr@2
    37
    {
williamr@2
    38
public:
williamr@4
    39
    /** 
williamr@4
    40
	Serializes the node.  The implementor of this class must allocate and own
williamr@4
    41
	the memory returned by this method until serialization is complete.
williamr@4
    42
    @param aNode A node to serialize
williamr@4
    43
    @return The serialized node
williamr@4
    44
	@leave - One of the system-wide error codes
williamr@4
    45
    */
williamr@2
    46
    virtual TPtrC8 SerializeDataL(TXmlEngNode aNode) = 0;
williamr@2
    47
    };
williamr@2
    48
williamr@2
    49
williamr@4
    50
#endif /* XMLENGMDATASERIALIZER_H */