1<!--$Id: db_set_lorder.so,v 10.38 2004/09/28 15:04:19 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->set_lorder</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->set_lorder</b> 14</td> 15<td align=right> 16<a href="../api_c/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 <db.h> 23<p> 24int 25DB->set_lorder(DB *db, int lorder); 26<p> 27int 28DB->get_lorder(DB *db, int *lorderp); 29</pre></b> 30<hr size=1 noshade> 31<b>Description: DB->set_lorder</b> 32<p>Set the byte order for integers in the stored database metadata. The 33host byte order of the machine where the Berkeley DB library was compiled will 34be used if no byte order is set.</p> 35<p><b>The access methods provide no guarantees about the byte ordering of the 36application data stored in the database, and applications are responsible 37for maintaining any necessary ordering.</b></p> 38<p>The DB->set_lorder method configures a database, not only operations performed 39using the specified <a href="../api_c/db_class.html">DB</a> handle.</p> 40<p>The DB->set_lorder method may not be called after the <a href="../api_c/db_open.html">DB->open</a> method is called. 41If the database already exists when 42<a href="../api_c/db_open.html">DB->open</a> is called, the information specified to DB->set_lorder will 43be ignored. 44</p> 45If creating additional databases in a single physical file, information 46specified to DB->set_lorder will be ignored and the byte order 47of the existing databases will be used. 48<p>The DB->set_lorder method 49returns a non-zero error value on failure 50and 0 on success. 51</p> 52<b>Parameters</b> <br> 53 <b>lorder</b><ul compact><li>The <b>lorder</b> parameter should represent the byte order as an 54integer; for example, big endian order is the number 4,321, and little 55endian order is the number 1,234.</ul> 56<br> 57<br><b>Errors</b> 58<p>The DB->set_lorder method 59may fail and return one of the following non-zero errors:</p> 60<br> 61<b>EINVAL</b><ul compact><li>If the method was called after <a href="../api_c/db_open.html">DB->open</a> was called; or if an 62invalid flag value or parameter was specified.</ul> 63<br> 64<hr size=1 noshade> 65<b>Description: DB->get_lorder</b> 66<p>The DB->get_lorder method returns the database byte order; a byte order of 4,321 indicates a big endian 67order, and a byte order of 1,234 indicates a little endian order.</p> 68<p>The DB->get_lorder method may be called at any time during the life of the 69application.</p> 70<p>The DB->get_lorder method 71returns a non-zero error value on failure 72and 0 on success. 73</p> 74<b>Parameters</b> <br> 75 <b>lorderp</b><ul compact><li>The DB->get_lorder method returns the 76database byte order in <b>lorderp</b>.</ul> 77<br> 78<hr size=1 noshade> 79<br><b>Class</b> 80<a href="../api_c/db_class.html">DB</a> 81<br><b>See Also</b> 82<a href="../api_c/db_list.html">Databases and Related Methods</a> 83</tt> 84<table width="100%"><tr><td><br></td><td align=right> 85<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> 86</td></tr></table> 87<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 88</body> 89</html> 90
