2010-03-28 22:10:10 +00:00
|
|
|
<?xml version="1.0" encoding="utf-8"?>
|
2009-07-11 07:28:18 +00:00
|
|
|
<!-- $Revision$ -->
|
2005-04-12 21:12:48 +00:00
|
|
|
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
2007-06-20 22:25:43 +00:00
|
|
|
<refentry xml:id="function.db2-field-display-size" xmlns="http://docbook.org/ns/docbook">
|
2005-04-12 21:12:48 +00:00
|
|
|
<refnamediv>
|
|
|
|
<refname>db2_field_display_size</refname>
|
|
|
|
<refpurpose>
|
|
|
|
Returns the maximum number of bytes required to display a column
|
|
|
|
</refpurpose>
|
|
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
|
|
&reftitle.description;
|
|
|
|
<methodsynopsis>
|
2005-05-04 09:39:11 +00:00
|
|
|
<type>int</type><methodname>db2_field_display_size</methodname>
|
2005-04-12 21:12:48 +00:00
|
|
|
<methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
|
|
|
|
<methodparam><type>mixed</type><parameter>column</parameter></methodparam>
|
|
|
|
</methodsynopsis>
|
|
|
|
|
2005-04-20 19:10:03 +00:00
|
|
|
<para>
|
|
|
|
Returns the maximum number of bytes required to display a column in a
|
|
|
|
result set.
|
|
|
|
</para>
|
2005-04-12 21:12:48 +00:00
|
|
|
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
|
|
&reftitle.parameters;
|
|
|
|
<para>
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><parameter>stmt</parameter></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2005-04-20 19:10:03 +00:00
|
|
|
Specifies a statement resource containing a result set.
|
2005-04-12 21:12:48 +00:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
|
|
<term><parameter>column</parameter></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
2005-04-20 19:10:03 +00:00
|
|
|
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.
|
2005-04-12 21:12:48 +00:00
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
|
|
&reftitle.returnvalues;
|
|
|
|
<para>
|
2005-04-20 19:10:03 +00:00
|
|
|
Returns an integer value with the maximum number of bytes required to
|
|
|
|
display the specified column. If the column does not exist in the result
|
|
|
|
set, <function>db2_field_display_size</function> returns &false;.
|
2005-04-12 21:12:48 +00:00
|
|
|
</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>
|
2005-04-20 20:38:24 +00:00
|
|
|
<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>
|
2005-04-12 21:12:48 +00:00
|
|
|
</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
|
2009-09-25 07:04:39 +00:00
|
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
2005-04-12 21:12:48 +00:00
|
|
|
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
|
|
|
|
-->
|