XmlContainer::dump

API Ref

#include <DbXml.hpp>

void XmlContainer::dump(std::ostream *out, u_int32_t flags=0);


Description: XmlContainer::dump

The XmlContainer::dump method dumps the container contents to the specified output stream. The container can be reconstructed by a call to XmlContainer::load.

The container must be closed; the system throws an exception if the container is open.

The container must be have been opened at least once; the system throws an exception if the underlying files have not yet been created.

Parameters

out
The output stream to which the container is to be dumped.

flags
Not currently used.

Errors

The XmlContainer::dump method may fail and throw XmlException, encapsulating one of the following non-zero errors:

CONTAINER_OPEN
The container is open.

DATABASE_ERROR
An error occurred in an underlying Berkeley DB database. The XmlException::getDbError method will return the error code for the error.

Class

XmlContainer, XmlDocument, XmlException, XmlIndexSpecification, XmlQueryContext, XmlQueryExpression, XmlResults, XmlUpdateContext, XmlValue

APIRef

Copyright (c) 1996-2003 Sleepycat Software, Inc. - All rights reserved.