db_get_byteswapped.html [plain text]
<!--$Id: db_get_byteswapped.so,v 10.23 2004/08/13 03:38:55 bostic Exp $-->
<!--Copyright (c) 1997,2007 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db::get_byteswapped</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<h3>Db::get_byteswapped</h3>
</td>
<td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db_cxx.h>
<p>
int
Db::get_byteswapped(int *isswapped);
</pre></h3>
<hr size=1 noshade>
<h3>Description: Db::get_byteswapped</h3>
<p>The Db::get_byteswapped method returns if the underlying database
files were created on an architecture of the same byte order as the
current one, or if they were not (that is, big-endian on a little-endian
machine, or vice versa). This information may be used to determine
whether application data needs to be adjusted for this architecture or
not.</p>
<p>The Db::get_byteswapped method may not be called before the <a href="../api_cxx/db_open.html">Db::open</a> method has been
called.</p>
<p>The Db::get_byteswapped 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.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>isswapped</b><dd>If the underlying database files were created on an architecture of the
same byte order as the current one. 0 is stored into the memory location
referenced by <b>isswapped</b>. If the underlying database files were
created on an architecture of a different byte order as the current one,
1 is stored into the memory location referenced by <b>isswapped</b>.
</dl>
<h3>Errors</h3>
<p>The Db::get_byteswapped method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<dl compact>
<dt>EINVAL<dd>If the method was called before <a href="../api_cxx/db_open.html">Db::open</a> was called; or if an
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_cxx/db_class.html">Db</a>
<h3>See Also</h3>
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2007 Oracle. All rights reserved.</font>
</body>
</html>