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_SEQUENCE->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 11. The DB_SEQUENCE Handle" /> 11 <link rel="prev" href="seqget_flags.html" title="DB_SEQUENCE->get_flags()" /> 12 <link rel="next" href="seqget_range.html" title="DB_SEQUENCE->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">DB_SEQUENCE->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 11. 23 The DB_SEQUENCE 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>DB_SEQUENCE->get_key()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db.h> 39 40int 41DB_SEQUENCE->get_key(DB_SEQUENCE *seq, DBT *key); </pre> 42 <p> 43 The <code class="methodname">DB_SEQUENCE->get_key()</code> method returns the key for the sequence. 44 </p> 45 <p> 46 The <code class="methodname">DB_SEQUENCE->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">DB_SEQUENCE->get_key()</code> <span> 51 <span> 52 method returns a non-zero error value on failure and 0 on success. 53 </span> 54 55 </span> 56 </p> 57 <div class="sect2" lang="en" xml:lang="en"> 58 <div class="titlepage"> 59 <div> 60 <div> 61 <h3 class="title"><a id="id1705028"></a>Parameters</h3> 62 </div> 63 </div> 64 </div> 65 <div class="sect3" lang="en" xml:lang="en"> 66 <div class="titlepage"> 67 <div> 68 <div> 69 <h4 class="title"><a id="id1705258"></a>key</h4> 70 </div> 71 </div> 72 </div> 73 <p> 74 The <span class="bold"><strong>key</strong></span> parameter references memory 75 into which a pointer to the key data is copied. 76 </p> 77 </div> 78 </div> 79 <div class="sect2" lang="en" xml:lang="en"> 80 <div class="titlepage"> 81 <div> 82 <div> 83 <h3 class="title"><a id="id1705029"></a>Class</h3> 84 </div> 85 </div> 86 </div> 87 <p> 88 <a class="link" href="seq.html" title="Chapter 11. The DB_SEQUENCE Handle">DB_SEQUENCE</a> 89 </p> 90 </div> 91 <div class="sect2" lang="en" xml:lang="en"> 92 <div class="titlepage"> 93 <div> 94 <div> 95 <h3 class="title"><a id="id1705607"></a>See Also</h3> 96 </div> 97 </div> 98 </div> 99 <p> 100 <a class="xref" href="seq.html#seqlist" title="Sequences and Related Methods">Sequences and Related Methods</a> 101 </p> 102 </div> 103 </div> 104 <div class="navfooter"> 105 <hr /> 106 <table width="100%" summary="Navigation footer"> 107 <tr> 108 <td width="40%" align="left"><a accesskey="p" href="seqget_flags.html">Prev</a> </td> 109 <td width="20%" align="center"> 110 <a accesskey="u" href="seq.html">Up</a> 111 </td> 112 <td width="40%" align="right"> <a accesskey="n" href="seqget_range.html">Next</a></td> 113 </tr> 114 <tr> 115 <td width="40%" align="left" valign="top">DB_SEQUENCE->get_flags() </td> 116 <td width="20%" align="center"> 117 <a accesskey="h" href="index.html">Home</a> 118 </td> 119 <td width="40%" align="right" valign="top"> DB_SEQUENCE->get_range()</td> 120 </tr> 121 </table> 122 </div> 123 </body> 124</html> 125