XmlContainer.getIndexSpecification

API Ref

import com.sleepycat.dbxml.*;

public XmlIndexSpecification getIndexSpecification(DbTxn *txn) throws XmlException;


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.txnBegin, otherwise, NULL.

Returns the current indexing specification for the container.

Throws

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

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

APIRef

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