php-doc-en/reference/ingres-ii/functions/ingres-field-nullable.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

110 lines
3.2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ingres-field-nullable" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ingres_field_nullable</refname>
<refpurpose>Test if a field is nullable</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ingres_field_nullable</methodname>
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
<para>
Test if a field is nullable.
</para>
<note>
<title>Related Configurations</title>
<para>
See <link
linkend="ini.ingres.array-index-start">ingres.array_index_start</link>
in <link linkend="ingres.configuration">Runtime Configuration</link>
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>result</parameter></term>
<listitem>
<para>
The query result identifier
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>index</parameter></term>
<listitem>
<para>
<parameter>index</parameter> is the field whose nullability will be
retrieved.
</para>
<para>
The possible values of <parameter>index</parameter> depend upon
the value
of <link linkend="ini.ingres.array-index-start">ingres.array_index_start</link>.
If <link linkend="ini.ingres.array-index-start">ingres.array_index_start</link>
is <literal>1</literal> (the default)
then <parameter>index</parameter> must be
between <literal>1</literal> and the value returned
by <function>ingres_num_fields</function>. If <link linkend="ini.ingres.array-index-start">ingres.array_index_start</link>
is <literal>0</literal> then <parameter>index</parameter> must
be between <literal>0</literal>
and <function>ingres_num_fields</function><literal> -
1</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>ingres_field_nullable</function> returns &true; if the
field can be set to the &null; value and &false; if it cannot
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ingres_query</function></member>
<member><function>ingres_fetch_array</function></member>
<member><function>ingres_fetch_assoc</function></member>
<member><function>ingres_fetch_object</function></member>
<member><function>ingres_fetch_row</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
-->