php-doc-en/reference/sqlite/functions/sqlite-key.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sqlite-key" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>sqlite_key</refname>
  <refname>SQLiteResult::key</refname>
  <refpurpose>Returns the current row index</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop; (method):</para>
  <methodsynopsis>
   <type>int</type><methodname>SQLiteResult::key</methodname>
   <void/>
  </methodsynopsis>
  <para>
   <methodname>SQLiteResult::key</methodname> returns the current row index of
   the buffered result set <parameter>result</parameter>.
  </para>
  <para>
   Unlike all other SQLite functions, this function does not have a procedural
   version, and can only be called as a method on a
   <classname>SQLiteResult</classname> object.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the current row index of the buffered result set
   <parameter>result</parameter>.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>sqlite_next</function></member>
    <member><function>sqlite_current</function></member>
    <member><function>sqlite_rewind</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
 sgml-omittag:t
 sgml-shorttag:t
 sgml-minimize-attributes:nil
 sgml-always-quote-attributes:t
 sgml-indent-step:1
 sgml-indent-data:t
 sgml-parent-document:nil
 sgml-default-dtd-file:"~/.phpdoc/manual.ced"
 sgml-exposed-tags:nil
 sgml-local-catalogs:nil
 sgml-local-ecat-files:nil
 End:
 vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
 -->