reference/uodbc/functions/odbc-specialcolumns.xml
0b26a7aff236130cc8f1e5d7adb9464a46fab689
...
...
@@ -9,11 +9,11 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>odbc_specialcolumns</methodname>
13
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
12
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_specialcolumns</methodname>
13
+
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
14
14
<methodparam><type>int</type><parameter>type</parameter></methodparam>
15
-
<methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>owner</parameter></methodparam>
15
+
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter></methodparam>
16
+
<methodparam><type>string</type><parameter>schema</parameter></methodparam>
17
17
<methodparam><type>string</type><parameter>table</parameter></methodparam>
18
18
<methodparam><type>int</type><parameter>scope</parameter></methodparam>
19
19
<methodparam><type>int</type><parameter>nullable</parameter></methodparam>
...
...
@@ -30,7 +30,7 @@
30
30
<para>
31
31
<variablelist>
32
32
<varlistentry>
33
-
<term><parameter>connection_id</parameter></term>
33
+
<term><parameter>odbc</parameter></term>
34
34
<listitem>
35
35
&odbc.connection.id;
36
36
</listitem>
...
...
@@ -52,18 +52,18 @@
52
52
</listitem>
53
53
</varlistentry>
54
54
<varlistentry>
55
-
<term><parameter>qualifier</parameter></term>
55
+
<term><parameter>catalog</parameter></term>
56
56
<listitem>
57
57
<para>
58
-
The qualifier.
58
+
&odbc.parameter.catalog;
59
59
</para>
60
60
</listitem>
61
61
</varlistentry>
62
62
<varlistentry>
63
-
<term><parameter>owner</parameter></term>
63
+
<term><parameter>schema</parameter></term>
64
64
<listitem>
65
65
<para>
66
-
The owner.
66
+
&odbc.parameter.schema;
67
67
</para>
68
68
</listitem>
69
69
</varlistentry>
...
...
@@ -80,6 +80,8 @@
80
80
<listitem>
81
81
<para>
82
82
The scope, which orders the result set.
83
+
One of <constant>SQL_SCOPE_CURROW</constant>, <constant>SQL_SCOPE_TRANSACTION</constant>
84
+
or <constant>SQL_SCOPE_SESSION</constant>.
83
85
</para>
84
86
</listitem>
85
87
</varlistentry>
...
...
@@ -87,7 +89,8 @@
87
89
<term><parameter>nullable</parameter></term>
88
90
<listitem>
89
91
<para>
90
-
The nullable option.
92
+
Determines whether to return special columns that can have a NULL value.
93
+
One of <constant>SQL_NO_NULLS</constant> or <constant>SQL_NULLABLE</constant>.
91
94
</para>
92
95
</listitem>
93
96
</varlistentry>
...
...
@@ -104,20 +107,32 @@
104
107
<para>
105
108
The result set has the following columns:
106
109
<itemizedlist>
107
-
<listitem><simpara>SCOPE</simpara></listitem>
108
-
<listitem><simpara>COLUMN_NAME</simpara></listitem>
109
-
<listitem><simpara>DATA_TYPE</simpara></listitem>
110
-
<listitem><simpara>TYPE_NAME</simpara></listitem>
111
-
<listitem><simpara>PRECISION</simpara></listitem>
112
-
<listitem><simpara>LENGTH</simpara></listitem>
113
-
<listitem><simpara>SCALE</simpara></listitem>
114
-
<listitem><simpara>PSEUDO_COLUMN</simpara></listitem>
110
+
<listitem><simpara><literal>SCOPE</literal></simpara></listitem>
111
+
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
112
+
<listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>
113
+
<listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>
114
+
<listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>
115
+
<listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>
116
+
<listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>
117
+
<listitem><simpara><literal>PSEUDO_COLUMN</literal></simpara></listitem>
115
118
</itemizedlist>
119
+
&odbc.result.driver-specific;
116
120
</para>
121
+
<simpara>
122
+
The result set is ordered by <literal>SCOPE</literal>.
123
+
</simpara>
117
124
</refsect1>
118
125

119
-
</refentry>
126
+
<refsect1 role="seealso">
127
+
&reftitle.seealso;
128
+
<para>
129
+
<simplelist>
130
+
<member><function>odbc_tables</function></member>
131
+
</simplelist>
132
+
</para>
133
+
</refsect1>
120
134

135
+
</refentry>
121
136
<!-- Keep this comment at the end of the file
122
137
Local variables:
123
138
mode: sgml
124
139