epoc32/include/xmlengoutputstream.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004-2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:       Interface class describing class that may be used as
williamr@2
    15
*                 output stream for dom tree
williamr@2
    16
*
williamr@2
    17
*/
williamr@2
    18
williamr@2
    19
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
#ifndef XMLENGINE_MOUTPUTSTREAM_H_INCLUDED
williamr@2
    26
#define XMLENGINE_MOUTPUTSTREAM_H_INCLUDED
williamr@2
    27
williamr@2
    28
#include <e32base.h>
williamr@2
    29
williamr@2
    30
williamr@2
    31
williamr@2
    32
/**
williamr@2
    33
 * MXmlEngOutputStream is used by XML Engine to write serialized XML data
williamr@2
    34
 * to stream. This interface should be implemented by client application
williamr@2
    35
 * when RXmlEngDocument::SaveL() method is used to serialize xml data to stream.
williamr@2
    36
 *
williamr@2
    37
 * @lib XmlEngineDOM.lib
williamr@2
    38
 * @since S60 v3.1
williamr@2
    39
 */
williamr@2
    40
class MXmlEngOutputStream
williamr@2
    41
    {
williamr@2
    42
public:
williamr@2
    43
    /**
williamr@2
    44
     * Callback for writing a buffer with data to output stream
williamr@2
    45
     *
williamr@2
    46
     * @since S60 v3.1
williamr@2
    47
     * @return number of bytes written or -1 in case of error
williamr@2
    48
     */
williamr@2
    49
    virtual TInt Write(const TDesC8& aBuffer) = 0;
williamr@2
    50
williamr@2
    51
    /**
williamr@2
    52
     * Callback for closing output stream
williamr@2
    53
     *
williamr@2
    54
     * @since S60 v3.1
williamr@2
    55
     * @return 
williamr@2
    56
     *       0 is succeeded, 
williamr@2
    57
     *      -1 in case of error
williamr@2
    58
     */
williamr@2
    59
    virtual TInt Close() = 0;
williamr@2
    60
    };
williamr@2
    61
williamr@2
    62
williamr@2
    63
williamr@2
    64
#endif /* XMLENGINE_MOUTPUTSTREAM_H_INCLUDED */