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>DbSequence::get_key()</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="seq.html" title="Chapter 12. The DbSequence Handle" /> 11 <link rel="prev" href="seqget_flags.html" title="DbSequence::get_flags()" /> 12 <link rel="next" href="seqget_range.html" title="DbSequence::get_range()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbSequence::get_key()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="seqget_flags.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 12. 23 The DbSequence Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="seqget_range.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="seqget_key"></a>DbSequence::get_key()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbSequence::get_key(Dbt *key);</pre> 42 <p> 43 The <code class="methodname">DbSequence::get_key()</code> method returns the key for the sequence. 44 </p> 45 <p> 46 The <code class="methodname">DbSequence::get_key()</code> method may be called at any time during the life of the 47 application. 48 </p> 49 <p> 50 The <code class="methodname">DbSequence::get_key()</code> <span> 51 52 <span> 53 method either returns a non-zero error value or throws an 54 exception that encapsulates a non-zero error value on 55 failure, and returns 0 on success. 56 </span> 57 </span> 58 </p> 59 <div class="sect2" lang="en" xml:lang="en"> 60 <div class="titlepage"> 61 <div> 62 <div> 63 <h3 class="title"><a id="id1709451"></a>Parameters</h3> 64 </div> 65 </div> 66 </div> 67 <div class="sect3" lang="en" xml:lang="en"> 68 <div class="titlepage"> 69 <div> 70 <div> 71 <h4 class="title"><a id="id1709945"></a>key</h4> 72 </div> 73 </div> 74 </div> 75 <p> 76 The <span class="bold"><strong>key</strong></span> parameter references memory 77 into which a pointer to the key data is copied. 78 </p> 79 </div> 80 </div> 81 <div class="sect2" lang="en" xml:lang="en"> 82 <div class="titlepage"> 83 <div> 84 <div> 85 <h3 class="title"><a id="id1710237"></a>Class</h3> 86 </div> 87 </div> 88 </div> 89 <p> 90 <a class="link" href="seq.html" title="Chapter 12. The DbSequence Handle">DbSequence</a> 91 </p> 92 </div> 93 <div class="sect2" lang="en" xml:lang="en"> 94 <div class="titlepage"> 95 <div> 96 <div> 97 <h3 class="title"><a id="id1710174"></a>See Also</h3> 98 </div> 99 </div> 100 </div> 101 <p> 102 <a class="xref" href="seq.html#seqlist" title="Sequences and Related Methods">Sequences and Related Methods</a> 103 </p> 104 </div> 105 </div> 106 <div class="navfooter"> 107 <hr /> 108 <table width="100%" summary="Navigation footer"> 109 <tr> 110 <td width="40%" align="left"><a accesskey="p" href="seqget_flags.html">Prev</a> </td> 111 <td width="20%" align="center"> 112 <a accesskey="u" href="seq.html">Up</a> 113 </td> 114 <td width="40%" align="right"> <a accesskey="n" href="seqget_range.html">Next</a></td> 115 </tr> 116 <tr> 117 <td width="40%" align="left" valign="top">DbSequence::get_flags() </td> 118 <td width="20%" align="center"> 119 <a accesskey="h" href="index.html">Home</a> 120 </td> 121 <td width="40%" align="right" valign="top"> DbSequence::get_range()</td> 122 </tr> 123 </table> 124 </div> 125 </body> 126</html> 127