#include <DbXml.hpp>

XmlIndexSpecification XmlContainer::getIndexSpecification()

XmlIndexSpecification XmlContainer::getIndexSpecification(XmlTransaction &txn,
    u_int32_t flags = 0)

Description: XmlContainer::getIndexSpecification

Retrieves the current indexing specification for the container. The indexing specification can be modified using XmlContainer::setIndexSpecification.

Parameters

txn

If the operation is to be transaction-protected, the txn parameter is an XmlTransaction handle returned from XmlManager::createTransaction.

flags

The flags parameter must be set to one of the following values:

DB_RMW

Acquire write locks instead of read locks when doing the retrieval. Setting this flag can eliminate deadlock during a read-modify-write cycle by acquiring the write lock during the read part of the cycle so that another thread of control acquiring a read lock for the same item, in its own read-modify-write cycle, will not result in deadlock.

Errors

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

DATABASE_ERROR

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