<?xml version="1.0" encoding="utf-8"?>

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.db2-num-fields">

<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>

<simpara>

結果セットに含まれるフィールドの数を返します。動的に生成されたクエリが返す

結果セットを処理する場合、あるいはストアドプロシージャから返された結果セットを

処理する場合など、結果セットの使用法がアプリケーションにわからない場合に有用です。

</simpara>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<variablelist>

<varlistentry>

<term><parameter>stmt</parameter></term>

<listitem>

<simpara>

結果セットを含む有効なステートメントリソース。

</simpara>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<simpara>

指定したステートメントリソースに関連付けられた結果セット内の

フィールドの数を表す整数値を返します。ステートメントリソースが

不正な値の場合には &false; を返します。

</simpara>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<example>

<title>結果セットのフィールド数の取得</title>

<simpara>

以下の例では、結果セットが返すフィールドの数を取得する方法を説明します。

</simpara>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</refsect1>

<refsect1 role="seealso">

&reftitle.seealso;

<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>

</refsect1>

</refentry>