db2-field-display-size.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: takagi Status: ready -->
<refentry xml:id="function.db2-field-display-size" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_field_display_size</refname>
  <refpurpose>
   カラムを表示するために必要な最大のバイト数を返す
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>db2_field_display_size</methodname>
   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
   <methodparam><type class="union"><type>int</type><type>string</type></type><parameter>column</parameter></methodparam>
  </methodsynopsis>

  <para>
   結果セット内のカラムを表示するために必要な最大のバイト数を返す
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stmt</parameter></term>
      <listitem>
       <para>
        結果セットを含むステートメントリソースを指定します。
       </para>
      </listitem>
     </varlistentry>
    <varlistentry>
     <term><parameter>column</parameter></term>
      <listitem>
       <para>
        結果セット内のカラムを指定します。0 から始まるインデックス、
        あるいはカラム名を表す文字列のいずれかが使用可能です。
       </para>
      </listitem>
     </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   指定したカラムを表示するために必要な最大バイト数を表す整数値を返します。
   結果セット内にそのカラムが存在しない場合には、
   <function>db2_field_display_size</function> は &false; を返します。
  </para>
 </refsect1>

 <!-- Use when examples exist
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>db2_field_display_size</function> example</title>
    <para>
     Any text that describes the purpose of the example, or
     what goes on in the example should go here (inside the
     <example> tag, not out
    </para>
    <programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
    echo 'Use the PEAR Coding Standards';
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <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
-->