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;
  <methodsynopsis>
   <type>int</type><methodname>sqlite_key</methodname>
   <methodparam><type>resource</type><parameter>result</parameter></methodparam>
  </methodsynopsis>
  <para>&style.oop; (method):</para>
  <methodsynopsis>
   <type>int</type><methodname>SQLiteResult::key</methodname>
   <void/>
  </methodsynopsis>
  <para>
   <function>sqlite_key</function> returns the current row index of the
   buffered result set <parameter>result</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>result</parameter></term>
     <listitem>
      <para>
       The SQLite result resource.  This parameter is not required when using
       the object-oriented method.
      </para>
      &sqlite.no-unbuffered;
     </listitem>
    </varlistentry>
   </variablelist>
  </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="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.0.4</entry>
       <entry>
        Prior to PHP 5.0.4, <function>sqlite_key</function> was only able to be
        called as a method on a
        <link linkend="sqlite.class.sqliteresult">SQLiteResult</link> object,
        not procedurally.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </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
 -->