db2-num-fields.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 266f9f6b4bf4bcaa1ef7f23d8eeaaed884b70aaa Maintainer: takagi Status: ready -->
<refentry xml:id="function.db2-num-fields" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_num_fields</refname>
  <refpurpose>
   結果セットに含まれるフィールドの数を返す
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>db2_num_fields</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
  </methodsynopsis>


  <para>
   結果セットに含まれるフィールドの数を返します。動的に生成されたクエリが返す
   結果セットを処理する場合、あるいはストアドプロシージャから返された結果セットを
   処理する場合など、結果セットの使用法がアプリケーションにわからない場合に有用です。
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
     <listitem>
      <para>
       結果セットを含む有効なステートメントリソース。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定したステートメントリソースに関連付けられた結果セット内の
   フィールドの数を表す整数値を返します。ステートメントリソースが
   不正な値の場合には &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>結果セットのフィールド数の取得</title>
    <para>
     以下の例では、結果セットが返すフィールドの数を取得する方法を説明します。
    </para>
    <programlisting role="php">
<![CDATA[
<?php

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

echo "結果セット内には {$columns} つのカラムがあります。";
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
結果セット内には 4 つのカラムがあります。
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_execute</function></member>
    <member><function>db2_field_display_size</function></member>
    <member><function>db2_field_name</function></member>
    <member><function>db2_field_num</function></member>
    <member><function>db2_field_precision</function></member>
    <member><function>db2_field_scale</function></member>
    <member><function>db2_field_type</function></member>
    <member><function>db2_field_width</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
-->