Berkeley DB: XmlDocument.getEncoding
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.getEncoding |

`

###

    import com.sleepycat.dbxml.*;

    public int getEncoding()
        throws XmlException;

    public String getEncodingName()
        throws XmlException;

# Description

The XmlDocument.getEncoding method returns the document encoding as one of the following types:

- Db.XmlDocument::EBCDIC
- Db.XmlDocument::NONE
- Db.XmlDocument::UCS4
- Db.XmlDocument::UCS4_ASCII
- Db.XmlDocument::UTF16
- Db.XmlDocument::UTF8

The XmlDocument.getEncodingName method returns the document encoding as a string.

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

# Errors

The XmlDocument.getEncoding 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 has no content stored in it.

If the requested item could not be returned due to insufficient memory, the XmlDocument.getEncoding method will fail and throw a DbMemoryException exception.

The XmlDocument.getEncoding 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.getEncoding 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