XmlContainer.deleteDocument
|
|
import com.sleepycat.dbxml.*;
public void deleteDocument(DbTxn txn, int id, XmlUpdateContext context, int flags)
throws XmlException;
public void deleteDocument(DbTxn txn, XmlDocument document, XmlUpdateContext context, int flags)
throws XmlException;
Description: XmlContainer.deleteDocument
The XmlContainer.deleteDocument method removes the specified
XmlDocument from the XmlContainer.
Parameters
- txn
-
If the operation is to be transaction-protected, the
txn parameter is a transaction handle returned from
DbEnv.txnBegin, otherwise, NULL.
- document
-
The XmlDocument to be deleted from the
container.
- context
-
(Optional) The update context within which the
document is to be deleted. The context provides a performance
improvement by caching objects that can be reused for multiple
operations.
- flags
-
Not currently used.
Throws
The XmlContainer.deleteDocument 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.
- DOCUMENT_NOT_FOUND
- The specified document is not in the XmlContainer.
Description: XmlContainer.deleteDocument
The XmlContainer.deleteDocument method removes the specified
XmlDocument from the XmlContainer.
Parameters
- txn
-
If the operation is to be transaction-protected, the
txn parameter is a transaction handle returned from
DbEnv.txnBegin, otherwise, NULL.
- id
-
The ID of the XmlDocument to be deleted from the
container.
- context
-
(Optional) The update context within which the
document is to be deleted. The context provides a performance
improvement by caching objects that can be reused for multiple
operations.
- flags
-
Not currently used.
Throws
The XmlContainer.deleteDocument 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.
- DOCUMENT_NOT_FOUND
- The specified document is not in the XmlContainer.
Class
XmlContainer,
XmlDocument,
XmlException,
XmlIndexSpecification,
XmlQueryContext,
XmlQueryExpression,
XmlResults,
XmlUpdateContext,
XmlValue
Copyright (c) 1996-2003 Sleepycat Software, Inc. - All rights reserved.