#include <DbXml.hpp>

XmlIndexSpecification XmlContainer::getIndexSpecification(DbTxn *txn);

Description: XmlContainer::getIndexSpecification

The XmlContainer::getIndexSpecification method retrieves the current indexing specification for the container. The indexing specification can be modified with the XmlContainer::setIndexSpecification method.

The application must open the container before attempting to retrieve its indexing specification.

Parameters

txn

If the operation is to be transaction-protected, the txn parameter is a transaction handle returned from DbEnv::txn_begin, otherwise, NULL.

Returns the current indexing specification for the container.

Errors

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

CONTAINER_CLOSED

The container is closed.

DATABASE_ERROR

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

Class