db2-fetch-both.xml

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


  <simpara>
   結果セット内の行を表す、
   カラム位置およびカラム名の両方をインデックスとする配列を返します。
   <function>db2_fetch_both</function> が返す行は、
   一種類のインデックスしか返さない <function>db2_fetch_assoc</function> あるいは
   <function>db2_fetch_array</function> よりもメモリを消費することに注意しましょう。
  </simpara>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>前進のみのカーソルを使用して順に処理する</title>
    <simpara>
     行番号を指定せずに <function>db2_fetch_both</function> をコールすると、
     自動的に結果セットの次の行を取得します。次の例では、
     返された配列に対してカラム名および数値インデックスの両方でアクセスします。
    </simpara>
    <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_both($stmt)) {
    printf ("%-5d %-16s %-32s %10s\n",
        $row['ID'], $row[0], $row['BREED'], $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_both</function> で取得する
    </title>
    <simpara>
     スクロール可能なカーソルを使用している場合は、行番号を指定して
     <function>db2_fetch_both</function> をコールすることができます。
     次の例は、結果セットの 2 行目から始めて 1 行おきにデータを取得します。
    </simpara>
    <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_both($result, $i)) {
    printf ("%-5d %-16s %-32s %10s\n",
        $row[0], $row['NAME'], $row[2], $row['WEIGHT']);
    $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;
  <simplelist>
   <member><function>db2_fetch_array</function></member>
   <member><function>db2_fetch_assoc</function></member>
   <member><function>db2_fetch_object</function></member>
   <member><function>db2_fetch_row</function></member>
   <member><function>db2_result</function></member>
  </simplelist>
 </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
-->