php-doc-en/reference/oracle/functions/ora-getcolumn.xml
Philip Olson 245cab7fc0 Documented ref.oci8 alternatives for each oracle function. Information taken
from user notes provided by christopher dot jones at oracle dot com.
And, added a changelog to each function mentioning ref.oracle is deprecated
as of PHP 5.1.0.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229243 c90b9560-bf6c-de11-be94-00142212c4b1
2007-02-07 06:51:55 +00:00

112 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
<refentry id="function.ora-getcolumn">
<refnamediv>
<refname>ora_getcolumn</refname>
<refpurpose>Get data from a fetched column</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ora_getcolumn</methodname>
<methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
<methodparam><type>int</type><parameter>column</parameter></methodparam>
</methodsynopsis>
<para>
Fetches the data for a column or function result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>cursor</parameter></term>
<listitem>
<para>
An Oracle cursor, opened with <function>ora_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The column number, as an integer.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the column data. If an error occurs, &false; is returned
and <function>ora_errorcode</function>
will return a non-zero value. Note, however, that a test for &false;
on the results from this function may be &true; in cases where there is
not error as well (&null; result, empty string, the number 0, the
string "0").
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>5.1.0</entry>
<entry>
&oracle.deprecated;
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<para>
&oracle.replacement.desc;
<simplelist>
<member><function>oci_result</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
-->