php-doc-en/reference/ifx/functions/ifx-fieldproperties.xml
Mehdi Achour 75ff211ab0 Document constants
Add missing cross-links
Fix documentation of ifx_fetch_field() which returns an associative array (User Note)
Fix example for ifx_fieldtypes() (UN)
Add examples for ifx_do(), ifx_num_fields() (UN)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228820 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-03 04:04:03 +00:00

102 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry id="function.ifx-fieldproperties">
<refnamediv>
<refname>ifx_fieldproperties</refname>
<refpurpose>List of SQL fieldproperties</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>ifx_fieldproperties</methodname>
<methodparam><type>resource</type><parameter>result_id</parameter></methodparam>
</methodsynopsis>
<para>
Returns the Informix SQL fieldproperties of every field in the
query as an associative array. Properties are encoded as:
"SQLTYPE;length;precision;scale;ISNULLABLE" where SQLTYPE = the
Informix type like "SQLVCHAR" etc. and ISNULLABLE = "Y" or "N".
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result_id</parameter></term>
<listitem>
<para>
<parameter>result_id</parameter> is a valid resultid returned by
<function>ifx_query</function> or
<function>ifx_prepare</function> (select type queries only!).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an associative array with fieldnames as key and the SQL
fieldproperties as data for a query with <parameter>result_id</parameter>.
Returns &false; on errors.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Informix SQL fieldproperties</title>
<programlisting role="php">
<![CDATA[
<?php
$properties = ifx_fieldproperties($resultid);
if (!isset($properties)) {
/* ... error ... */
}
foreach ($properties as $fname => $val) {
echo "$fname:\t property = $val\n";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ifx_fieldtypes</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
-->