docs/api_reference/CXX/dbget_open_flags.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6     <title>Db::get_open_flags()</title>
   7     <link rel="stylesheet" href="apiReference.css" type="text/css" />
   8     <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
   9     <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
  10     <link rel="up" href="db.html" title="Chapter 2.  The Db Handle" />
  11     <link rel="prev" href="dbget_multiple.html" title="Db::get_multiple()" />
  12     <link rel="next" href="dbget_partition_callback.html" title="Db::get_partition_callback()" />
  13   </head>
  14   <body>
  15     <div xmlns="" class="navheader">
  16       <div class="libver">
  17         <p>Library Version 11.2.5.3</p>
  18       </div>
  19       <table width="100%" summary="Navigation header">
  20         <tr>
  21           <th colspan="3" align="center">Db::get_open_flags()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="dbget_multiple.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 2.
  26                 The Db Handle
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="dbget_partition_callback.html">Next</a></td>
  29         </tr>
  30       </table>
  31       <hr />
  32     </div>
  33     <div class="sect1" lang="en" xml:lang="en">
  34       <div class="titlepage">
  35         <div>
  36           <div>
  37             <h2 class="title" style="clear: both"><a id="dbget_open_flags"></a>Db::get_open_flags()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
  42
  43 int
  44 Db::get_open_flags(u_int32_t *flagsp); </pre>
  45       <p>
  46          The <code class="methodname">Db::get_open_flags()</code> method returns the current open method
  47          flags. That is, this method returns the flags that were specified when
  48          <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> was called.
  49     </p>
  50       <p>
  51          The <code class="methodname">Db::get_open_flags()</code> method may not be called before the
  52          <code class="methodname">Db::open()</code> method is called.
  53     </p>
  54       <p>
  55          The <code class="methodname">Db::get_open_flags()</code> <span>
  56
  57             <span>
  58                 method either returns a non-zero error value or throws an
  59                 exception that encapsulates a non-zero error value on
  60                 failure, and returns 0 on success.
  61             </span>
  62         </span>
  63     </p>
  64       <div class="sect2" lang="en" xml:lang="en">
  65         <div class="titlepage">
  66           <div>
  67             <div>
  68               <h3 class="title"><a id="idm7103024"></a>Parameters</h3>
  69             </div>
  70           </div>
  71         </div>
  72         <div class="sect3" lang="en" xml:lang="en">
  73           <div class="titlepage">
  74             <div>
  75               <div>
  76                 <h4 class="title"><a id="idm6137960"></a>flagsp</h4>
  77               </div>
  78             </div>
  79           </div>
  80           <p>
  81                           The <code class="methodname">Db::get_open_flags()</code> method returns  the current open method
  82                           flags in <span class="bold"><strong>flagsp</strong></span>.
  83                      </p>
  84         </div>
  85       </div>
  86       <div class="sect2" lang="en" xml:lang="en">
  87         <div class="titlepage">
  88           <div>
  89             <div>
  90               <h3 class="title"><a id="idm7290368"></a>Class</h3>
  91             </div>
  92           </div>
  93         </div>
  94         <p>
  95                 <a class="link" href="db.html" title="Chapter 2.  The Db Handle">Db</a>
  96             </p>
  97       </div>
  98       <div class="sect2" lang="en" xml:lang="en">
  99         <div class="titlepage">
 100           <div>
 101             <div>
 102               <h3 class="title"><a id="idm2176928"></a>See Also</h3>
 103             </div>
 104           </div>
 105         </div>
 106         <p>
 107                      <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>
 108                 </p>
 109       </div>
 110     </div>
 111     <div class="navfooter">
 112       <hr />
 113       <table width="100%" summary="Navigation footer">
 114         <tr>
 115           <td width="40%" align="left"><a accesskey="p" href="dbget_multiple.html">Prev</a> </td>
 116           <td width="20%" align="center">
 117             <a accesskey="u" href="db.html">Up</a>
 118           </td>
 119           <td width="40%" align="right"> <a accesskey="n" href="dbget_partition_callback.html">Next</a></td>
 120         </tr>
 121         <tr>
 122           <td width="40%" align="left" valign="top">Db::get_multiple() </td>
 123           <td width="20%" align="center">
 124             <a accesskey="h" href="index.html">Home</a>
 125           </td>
 126           <td width="40%" align="right" valign="top"> Db::get_partition_callback()</td>
 127         </tr>
 128       </table>
 129     </div>
 130   </body>
 131 </html>