Berkeley DB: XmlDocument::getID
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# XmlDocument::getID |

`

###

    #include <DbXml.hpp>

    u_int32_t
    XmlDocument::getID() const;

# Description

The XmlDocument::getID method returns the document ID. The document ID will be zero if the document has not yet been assigned any content, or the document has not yet been added to a container.

The flags parameter is currently unused, and must be set to 0.

The XmlDocument::getID method throws an exception that encapsulates a non-zero error value on failure.

# Errors

The XmlDocument::getID method may fail and throw an exception encapsulating a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  The document does not have an ID.

The XmlDocument::getID method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the XmlDocument::getID method may fail and throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

XmlContainer, XmlDocument, XmlQueryContext

# See Also

XmlContainer::close, XmlContainer::declareIndex, XmlContainer::deleteDocument, XmlContainer::getDocument, XmlContainer::getName, XmlContainer::open, XmlContainer::putDocument and XmlContainer::queryWithXPath.

XmlDocument::getAttributeValue, XmlDocument::getContent, XmlDocument::getID, XmlDocument::getName, XmlDocument::getType, XmlDocument::setContent, XmlDocument::setName, and XmlDocument::setType.

`

Copyright Sleepycat Software