<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>DbEnv::get_shm_key()</title> <link rel="stylesheet" href="apiReference.css" type="text/css" /> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> <link rel="up" href="env.html" title="Chapter 5. The DbEnv Handle" /> <link rel="prev" href="envget_open_flags.html" title="DbEnv::get_open_flags()" /> <link rel="next" href="envget_thread_count.html" title="DbEnv::get_thread_count()" /> </head> <body> <div xmlns="" class="navheader"> <div class="libver"> <p>Library Version 11.2.5.3</p> </div> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DbEnv::get_shm_key()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="envget_open_flags.html">Prev</a> </td> <th width="60%" align="center">Chapter 5. The DbEnv Handle </th> <td width="20%" align="right"> <a accesskey="n" href="envget_thread_count.html">Next</a></td> </tr> </table> <hr /> </div> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"><a id="envget_shm_key"></a>DbEnv::get_shm_key()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::get_shm_key(long *shm_keyp);</pre> <p> The <code class="methodname">DbEnv::get_shm_key()</code> method returns the base segment ID. This is used for Berkeley DB environment shared memory regions created in system memory on VxWorks or systems supporting X/Open-style shared memory interfaces. It may be specified using the <a class="xref" href="envset_shm_key.html" title="DbEnv::set_shm_key()">DbEnv::set_shm_key()</a> method. </p> <p> The <code class="methodname">DbEnv::get_shm_key()</code> method may be called at any time during the life of the application. </p> <p> The <code class="methodname">DbEnv::get_shm_key()</code> <span> <span> 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. </span> </span> </p> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp1560976"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp1560328"></a>shm_keyp</h4> </div> </div> </div> <p> The <code class="methodname">DbEnv::get_shm_key()</code> method returns the base segment ID in <span class="bold"><strong>shm_keyp</strong></span>. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp1554944"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp1546872"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>, <a class="xref" href="envset_shm_key.html" title="DbEnv::set_shm_key()">DbEnv::set_shm_key()</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="envget_open_flags.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="env.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="envget_thread_count.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DbEnv::get_open_flags() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::get_thread_count()</td> </tr> </table> </div> </body> </html>