db_set_lorder.html [plain text]
<!--$Id: db_set_lorder.html,v 1.1.1.1 2003/02/15 04:55:50 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db.set_lorder</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h1>Db.set_lorder</h1>
</td>
<td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public void set_lorder(int lorder)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>Set the byte order for integers in the stored database metadata. The
number should represent the order as an integer; for example, big endian
order is the value 4,321, and little endian order is the value 1,234.
If <b>lorder</b> is not explicitly set, the host order of the machine
where the Berkeley DB library was compiled is used.
<p><b>The access methods provide no guarantees about the byte ordering of the
application data stored in the database, and applications are responsible
for maintaining any necessary ordering.</b>
<p>The Db.set_lorder method configures a database, not only operations performed
using the specified <a href="../api_java/db_class.html">Db</a> handle.
<p>The Db.set_lorder interface may not be called after the <a href="../api_java/db_open.html">Db.open</a>
interface is called.
If the database already exists when
<a href="../api_java/db_open.html">Db.open</a> is called, the information specified to Db.set_lorder will
be ignored.
If creating additional databases in a file, the byte order specified must
be consistent with the existing databases in the file or an error will be
returned.
<p>The Db.set_lorder method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The Db.set_lorder method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>Called after <a href="../api_java/db_open.html">Db.open</a> was called.
</dl>
<p>The Db.set_lorder method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the Db.set_lorder method may fail and
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../api_java/db_class.html">Db</a>
<h1>See Also</h1>
<a href="../api_java/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>