Source of: /manual/en/function.sqlite-key.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sqlite.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.sqlite-key.php',
1 => 'sqlite_key',
),
'up' =>
array (
0 => 'ref.sqlite.php',
1 => 'SQLite Functions',
),
'prev' =>
array (
0 => 'function.sqlite-has-prev.php',
1 => 'sqlite_has_prev',
),
'next' =>
array (
0 => 'function.sqlite-last-error.php',
1 => 'sqlite_last_error',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.sqlite-key" class="refentry">
<div class="refnamediv">
<h1 class="refname">sqlite_key</h1>
<h1 class="refname">SQLiteResult->key</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">sqlite_key</span> -- <span class="refname">SQLiteResult->key</span> — <span class="dc-title">Returns the current row index</span></p>
</div>
<a name="function.sqlite-key.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><b>sqlite_key</b></span>
( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$result</tt></span>
)</div>
<p class="para rdfs-comment">Object oriented style (method):</p>
<div class="classsynopsis">
<div class="ooclass"><b class="classname">SQLiteResult</b></div>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><a href="function.key.php" class="function">key</a></span>
( <span class="methodparam">void</span>
)</div>
</div>
<p class="para">
<b>sqlite_key()</b> returns the current row index of the
buffered result set <i><tt class="parameter">result</tt></i>
.
</p>
</div>
<a name="function.sqlite-key.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">result</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
The SQLite result resource. This parameter is not required when using
the object-oriented method.
</p>
<blockquote><p><b class="note">Note</b>: This function cannot be used with
unbuffered result handles.<br /></p></blockquote>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.sqlite-key.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the current row index of the buffered result set
<i><tt class="parameter">result</tt></i>
.
</p>
</div>
<a name="function.sqlite-key.changelog"></a><div class="refsect1 changelog">
<h3 class="title">Changelog</h3>
<p class="para">
</p><table class="doctable informaltable">
<thead valign="middle">
<tr valign="middle">
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody valign="middle" class="tbody">
<tr valign="middle">
<td align="left">5.0.4</td>
<td align="left">
Prior to PHP 5.0.4, <b>sqlite_key()</b> was only able to be
called as a method on a
<a href="ref.sqlite.php#sqlite.class.sqliteresult" class="link">SQLiteResult</a> object,
not procedurally.
</td>
</tr>
</tbody>
</table>
<p>
</p>
</div>
<a name="function.sqlite-key.seealso"></a><div class="refsect1 seealso">
<h3 class="title">See Also</h3>
<p class="para">
</p><ul class="simplelist">
<li class="member"><a href="function.sqlite-next.php" class="function" rel="rdfs-seeAlso">sqlite_next()</a> - Seek to the next row number</li>
<li class="member"><a href="function.sqlite-current.php" class="function" rel="rdfs-seeAlso">sqlite_current()</a> - Fetches the current row from a result set as an array</li>
<li class="member"><a href="function.sqlite-rewind.php" class="function" rel="rdfs-seeAlso">sqlite_rewind()</a> - Seek to the first row number</li>
</ul><p>
</p>
</div>
</div><?php manual_footer(); ?>
