php-doc-en/reference/sqlite3/sqlite3result/columnname.xml
Máté Kocsis d15a12639f Generate sqlite3 methodsynopses based on stubs
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-303.
2021-01-01 23:40:36 +01:00

70 lines
2 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="sqlite3result.columnname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3Result::columnName</refname>
<refpurpose>Returns the name of the nth column</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SQLite3Result::columnName</methodname>
<methodparam><type>int</type><parameter>column</parameter></methodparam>
</methodsynopsis>
<para>
Returns the name of the column specified by the
<parameter>column</parameter>.
Note that the name of a result column is the value of the <literal>AS</literal> clause
for that column, if there is an <literal>AS</literal> clause. If there is no <literal>AS</literal>
clause then the name of the column is unspecified and may change from one release of libsqlite3
to the next.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The numeric zero-based index of the column.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the <type>string</type> name of the column identified by
<parameter>column</parameter>, or &false; if the column does not exist.
</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
-->