db2-fetch-array.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: takagi Status: ready -->
<refentry xml:id="function.db2-fetch-array" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_fetch_array</refname>
  <refpurpose>
   結果セット内の行を表す、カラム位置をインデックスとする配列を返す
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>db2_fetch_array</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>row_number</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>


  <para>
   結果セット内の行を表す、カラム位置をインデックスとする配列を返します。
   インデックスは 0 から始まります。
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       結果セットを含む有効な <literal>stmt</literal> リソース。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>row_number</parameter></term>
     <listitem>
      <para>
       結果セット内の 1 から始まる行番号を指定します。
       結果セットで前進のみのカーソルを使用している場合にこのパラメータを渡すと、
       PHP の警告が発生します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   結果セットの次の行あるいは要求した行のデータを表す配列を返します。
   配列の 0 から始まるインデックスが、カラムの位置を表します。
   結果セットに行がもうない場合、あるいは
   <parameter>row_number</parameter>
   で指定された行が結果セットに存在しない場合に &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>前進のみのカーソルを使用して順に処理する</title>
    <para>
     行番号を指定せずに <function>db2_fetch_array</function> をコールすると、
     自動的に結果セットの次の行を取得します。
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$sql = "SELECT id, name, breed, weight FROM animals ORDER BY breed";
$stmt = db2_prepare($conn, $sql);
$result = db2_execute($stmt);

while ($row = db2_fetch_array($stmt)) {
    printf ("%-5d %-16s %-32s %10s\n", 
        $row[0], $row[1], $row[2], $row[3]);
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0     Pook             cat                                    3.20
5     Rickety Ride     goat                                   9.70
2     Smarty           horse                                350.00
]]>
    </screen>
   </example>

   <example>
    <title>
     スクロール可能なカーソルから、指定した行を
     <function>db2_fetch_array</function> で取得する
    </title>
    <para>
     スクロール可能なカーソルを使用している場合は、行番号を指定して
     <function>db2_fetch_array</function> をコールすることができます。
     次の例は、結果セットの 2 行目から始めて 1 行おきにデータを取得します。
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$sql = "SELECT id, name, breed, weight FROM animals ORDER BY breed";
$result = db2_exec($stmt, $sql, array('cursor' => DB2_SCROLLABLE));

$i=2;
while ($row = db2_fetch_array($result, $i)) {
    printf ("%-5d %-16s %-32s %10s\n", 
        $row[0], $row[1], $row[2], $row[3]);
    $i = $i + 2;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
0     Pook             cat                                    3.20
5     Rickety Ride     goat                                   9.70
2     Smarty           horse                                350.00
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_fetch_assoc</function></member>
    <member><function>db2_fetch_both</function></member>
    <member><function>db2_fetch_object</function></member>
    <member><function>db2_fetch_row</function></member>
    <member><function>db2_result</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
indent-tabs-mode:nil
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
-->