2011-09-13 17:44:24 +00:00
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< title > Dbc::close()< / title >
< link rel = "stylesheet" href = "apiReference.css" type = "text/css" / >
< meta name = "generator" content = "DocBook XSL Stylesheets V1.73.2" / >
< link rel = "start" href = "index.html" title = "Berkeley DB C++ API Reference" / >
< link rel = "up" href = "dbc.html" title = "Chapter / >
< link rel = "prev" href = "dbcursor.html" title = "Db::cursor()" / >
< link rel = "next" href = "dbccmp.html" title = "Dbc::cmp()" / >
< / head >
< body >
< div xmlns = "" class = "navheader" >
< div class = "libver" >
< p > Library Version 11.2.5.2< / p >
< / div >
< table width = "100%" summary = "Navigation header" >
< tr >
< th colspan = "3" align = "center" > Dbc::close()< / th >
< / tr >
< tr >
< td width = "20%" align = "left" > < a accesskey = "p" href = "dbcursor.html" > Prev< / a > < / td >
< th width = "60%" align = "center" > Chapter
The Dbc Handle
< / th >
< td width = "20%" align = "right" > < a accesskey = "n" href = "dbccmp.html" > Next< / a > < / td >
< / tr >
< / table >
< hr / >
< / div >
< div class = "sect1" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
< h2 class = "title" style = "clear: both" > < a id = "dbcclose" > < / a > Dbc::close()< / h2 >
< / div >
< / div >
< / div >
< pre class = "programlisting" > #include < db_cxx.h>
int
Dbc::close(void);< / pre >
< p >
The < code class = "methodname" > Dbc::close()< / code > method discards the cursor.
< / p >
< p >
It is possible for the < code class = "methodname" > Dbc::close()< / code > method to return < a href = "../../programmer_reference/program_errorret.html#program_errorret.DB_LOCK_DEADLOCK" class = "olink" > DB_LOCK_DEADLOCK< / a > ,
signaling that any enclosing transaction should be aborted. If the
application is already intending to abort the transaction, this error
should be ignored, and the application should proceed.
< / p >
< p >
After the < code class = "methodname" > Dbc::close()< / code > method has been called, regardless of its return value,
you can not use the cursor handle again.
< / p >
< p >
It is not required to close the cursor explicitly before closing the database handle or the transaction handle that owns this cursor
because, closing a database handle or a transaction handle closes those open cursors.
< / p >
< p >
However, it is recommended that you always close all cursor handles immediately after
their use to promote concurrency and to release resources such as page locks.
< / p >
< p >
The < code class = "methodname" > Dbc::close()< / code > < span >
< span >
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
< / span >
< / span >
< / p >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3584185" > < / a > Errors< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The < code class = "methodname" > Dbc::close()< / code > < span >
< span >
method may fail and throw a < a class = "link" href = "dbexception.html" title = "Chapter > DbException< / a >
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
< / span >
< / span >
< / p >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3584681" > < / a > < span > DbDeadlockException or < / span > DB_LOCK_DEADLOCK< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
A transactional database environment operation was selected to resolve
a deadlock.
< / p >
< p >
< a class = "xref" href = "dbdeadlock.html" title = "DbDeadlockException" > DbDeadlockException< / a > is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, < code class = "literal" > DB_LOCK_DEADLOCK< / code > is returned.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3584459" > < / a > < span > DbLockNotGrantedException or < / span > DB_LOCK_NOTGRANTED< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
A Berkeley DB Concurrent Data Store database environment configured
for lock timeouts was unable to grant a lock in the allowed time.
< / p >
< p >
< a class = "xref" href = "dblocknotgranted.html" title = "DbLockNotGrantedException" > DbLockNotGrantedException< / a > is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, < code class = "literal" > DB_LOCK_NOTGRANTED< / code > is returned.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3584716" > < / a > EINVAL< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
If the cursor is already closed; or if an invalid flag value or parameter was specified.
< / p >
< / div >
< / div >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3584723" > < / a > Class< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
< a class = "link" href = "dbc.html" title = "Chapter > Dbc< / a >
< / p >
< / div >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3584253" > < / a > See Also< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
< a class = "xref" href = "dbc.html#dbclist" title = "Database Cursors and Related Methods" > Database Cursors and Related Methods< / a >
< / p >
< / div >
< / div >
< div class = "navfooter" >
< hr / >
< table width = "100%" summary = "Navigation footer" >
< tr >
< td width = "40%" align = "left" > < a accesskey = "p" href = "dbcursor.html" > Prev< / a > < / td >
< td width = "20%" align = "center" >
< a accesskey = "u" href = "dbc.html" > Up< / a >
< / td >
< td width = "40%" align = "right" > < a accesskey = "n" href = "dbccmp.html" > Next< / a > < / td >
< / tr >
< tr >
< td width = "40%" align = "left" valign = "top" > Db::cursor() < / td >
< td width = "20%" align = "center" >
< a accesskey = "h" href = "index.html" > Home< / a >
< / td >
< td width = "40%" align = "right" valign = "top" > < / td >
< / tr >
< / table >
< / div >
< / body >
< / html >
