1<!--$Id: db_get_byteswapped.so,v 10.24 2007/09/21 20:06:01 bostic Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: Db::get_byteswapped</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>Db::get_byteswapped</b>
14</td>
15<td align=right>
16<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db_cxx.h&gt;
23<p>
24int
25Db::get_byteswapped(int *isswapped);
26</pre></b>
27<hr size=1 noshade>
28<b>Description: Db::get_byteswapped</b>
29<p>The Db::get_byteswapped method returns if the underlying database
30files were created on an architecture of the same byte order as the
31current one, or if they were not (that is, big-endian on a little-endian
32machine, or vice versa). This information may be used to determine
33whether application data needs to be adjusted for this architecture or
34not.</p>
35<p>The Db::get_byteswapped method may not be called before the <a href="../api_cxx/db_open.html">Db::open</a> method is called.</p>
36<p>The Db::get_byteswapped method
37either returns a non-zero error value
38or throws an exception that encapsulates a non-zero error value on
39failure, and returns 0 on success.
40</p>
41<b>Parameters</b> <br>
42 <b>isswapped</b><ul compact><li>If the underlying database files were created on an architecture of the
43same byte order as the current one. 0 is stored into the memory location
44referenced by <b>isswapped</b>.  If the underlying database files were
45created on an architecture of a different byte order as the current one,
461 is stored into the memory location referenced by <b>isswapped</b>.</ul>
47<br>
48<br><b>Errors</b>
49<p>The Db::get_byteswapped method
50may fail and throw
51<a href="../api_cxx/except_class.html">DbException</a>,
52encapsulating one of the following non-zero errors, or return one of
53the following non-zero errors:</p>
54<br>
55<b>EINVAL</b><ul compact><li>If the method was called before <a href="../api_cxx/db_open.html">Db::open</a> was called; or if an
56invalid flag value or parameter was specified.</ul>
57<br>
58<hr size=1 noshade>
59<br><b>Class</b>
60<a href="../api_cxx/db_class.html">Db</a>
61<br><b>See Also</b>
62<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
63</tt>
64<table width="100%"><tr><td><br></td><td align=right>
65<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>
66</td></tr></table>
67<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
68</body>
69</html>
70