mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
bbced252b5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288299 c90b9560-bf6c-de11-be94-00142212c4b1
105 lines
3.2 KiB
XML
105 lines
3.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ingres-field-scale" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ingres_field_scale</refname>
|
|
<refpurpose>Get the scale of a field</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ingres_field_scale</methodname>
|
|
<methodparam><type>resource</type><parameter>result</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>index</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>ingres_field_scale</function> returns the scale of a
|
|
field. This value is used only for the decimal SQL data
|
|
type. For detailed information, see the Ingres <literal>OpenAPI User
|
|
Guide</literal>, Appendix <literal>"Data Types"</literal> in the Ingres documentation.
|
|
</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 scale will be
|
|
retrieved. The start and end values for <parameter>index</parameter> depends
|
|
on 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 0 then
|
|
the field number must be between 0 and one less than the value given by
|
|
<function>ingres_num_fields</function>. Else if <link
|
|
linkend="ini.ingres.array-index-start">ingres.array_index_start</link> is 1 then
|
|
the field number must be between 1 and the value given by
|
|
<function>ingres_num_fields</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the scale of the field, as an integer
|
|
</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_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:"../../../../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
|
|
-->
|