php-doc-en/reference/ibm_db2/functions/db2-field-width.xml
Jakub Vrana 9c43f894a1 Fix parameters and function names
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@185775 c90b9560-bf6c-de11-be94-00142212c4b1
2005-05-04 09:39:11 +00:00

128 lines
3.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.db2-field-width">
<refnamediv>
<refname>db2_field_width</refname>
<refpurpose>
Returns the width of the current value of the indicated column in a result set
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>db2_field_width</methodname>
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
<methodparam><type>mixed</type><parameter>column</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns the width of the current value of the indicated column in a result
set. This is the maximum width of the column for a fixed-length data type,
or the actual width of the column for a variable-length data type.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>stmt</parameter></term>
<listitem>
<para>
Specifies a statement resource containing a result set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
Specifies the column in the result set. This can either be an integer
representing the 0-indexed position of the column, or a string
containing the name of the column.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an integer containing the width of the specified character or
binary data type column in a result set. If the specified column does not
exist in the result set, <function>db2_field_width</function> returns
&false;.
</para>
</refsect1>
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>db2_field_width</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_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>
</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:"../../../../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
-->