reference/sqlite3/sqlite3result/columnname.xml
855bfee2f3db70d7dbb4c60c7c4a4efa567f1c60
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="sqlite3result.columnname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>SQLite3Result::columnName</refname>
...
...
@@ -9,13 +8,17 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <type>string</type><methodname>SQLite3Result::columnName</methodname>
14
-
<methodparam><type>int</type><parameter>column_number</parameter></methodparam>
11
+
<methodsynopsis role="SQLite3Result">
12
+
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>SQLite3Result::columnName</methodname>
13
+
<methodparam><type>int</type><parameter>column</parameter></methodparam>
15
14
</methodsynopsis>
16
15
<para>
17
16
Returns the name of the column specified by the
18
-
<parameter>column_number</parameter>.
17
+
<parameter>column</parameter>.
18
+
Note that the name of a result column is the value of the <literal>AS</literal> clause
19
+
for that column, if there is an <literal>AS</literal> clause. If there is no <literal>AS</literal>
20
+
clause then the name of the column is unspecified and may change from one release of libsqlite3
21
+
to the next.
19
22
</para>
20
23
</refsect1>
21
24

...
...
@@ -24,7 +27,7 @@
24
27
<para>
25
28
<variablelist>
26
29
<varlistentry>
27
-
<term><parameter>column_number</parameter></term>
30
+
<term><parameter>column</parameter></term>
28
31
<listitem>
29
32
<para>
30
33
The numeric zero-based index of the column.
...
...
@@ -40,12 +43,11 @@
40
43
&reftitle.returnvalues;
41
44
<para>
42
45
Returns the <type>string</type> name of the column identified by
43
-
<parameter>column_number</parameter>.
46
+
<parameter>column</parameter>, or &false; if the column does not exist.
44
47
</para>
45
48
</refsect1>
46
49

47
50
</refentry>
48
-

49
51
<!-- Keep this comment at the end of the file
50
52
Local variables:
51
53
mode: sgml
52
54