reference/uodbc/functions/odbc-procedurecolumns.xml
902c2b77f827e8d0ecccf4f62fb90065d2f6ef79
...
...
@@ -9,16 +9,12 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>odbc_procedurecolumns</methodname>
13
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
14
-
</methodsynopsis>
15
-
<methodsynopsis>
16
-
<type>resource</type><methodname>odbc_procedurecolumns</methodname>
17
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
18
-
<methodparam><type>string</type><parameter>qualifier</parameter></methodparam>
19
-
<methodparam><type>string</type><parameter>owner</parameter></methodparam>
20
-
<methodparam><type>string</type><parameter>proc</parameter></methodparam>
21
-
<methodparam><type>string</type><parameter>column</parameter></methodparam>
12
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_procedurecolumns</methodname>
13
+
<methodparam><type>resource</type><parameter>odbc</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter><initializer>&null;</initializer></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>
16
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>procedure</parameter><initializer>&null;</initializer></methodparam>
17
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>column</parameter><initializer>&null;</initializer></methodparam>
22
18
</methodsynopsis>
23
19
<para>
24
20
Retrieve information about parameters to procedures.
...
...
@@ -30,30 +26,30 @@
30
26
<para>
31
27
<variablelist>
32
28
<varlistentry>
33
-
<term><parameter>connection_id</parameter></term>
29
+
<term><parameter>odbc</parameter></term>
34
30
<listitem>
35
31
&odbc.connection.id;
36
32
</listitem>
37
33
</varlistentry>
38
34
<varlistentry>
39
-
<term><parameter>qualifier</parameter></term>
35
+
<term><parameter>catalog</parameter></term>
40
36
<listitem>
41
37
<para>
42
-
The qualifier.
38
+
&odbc.parameter.catalog;
43
39
</para>
44
40
</listitem>
45
41
</varlistentry>
46
42
<varlistentry>
47
-
<term><parameter>owner</parameter></term>
43
+
<term><parameter>schema</parameter></term>
48
44
<listitem>
49
45
<para>
50
-
The owner.
46
+
&odbc.parameter.schema;
51
47
&odbc.parameter.search;
52
48
</para>
53
49
</listitem>
54
50
</varlistentry>
55
51
<varlistentry>
56
-
<term><parameter>proc</parameter></term>
52
+
<term><parameter>procedure</parameter></term>
57
53
<listitem>
58
54
<para>
59
55
The proc.
...
...
@@ -84,29 +80,113 @@
84
80
<para>
85
81
The result set has the following columns:
86
82
<itemizedlist>
87
-
<listitem><simpara>PROCEDURE_QUALIFIER</simpara></listitem>
88
-
<listitem><simpara>PROCEDURE_OWNER</simpara></listitem>
89
-
<listitem><simpara>PROCEDURE_NAME</simpara></listitem>
90
-
<listitem><simpara>COLUMN_NAME</simpara></listitem>
91
-
<listitem><simpara>COLUMN_TYPE</simpara></listitem>
92
-
<listitem><simpara>DATA_TYPE</simpara></listitem>
93
-
<listitem><simpara>TYPE_NAME</simpara></listitem>
94
-
<listitem><simpara>PRECISION</simpara></listitem>
95
-
<listitem><simpara>LENGTH</simpara></listitem>
96
-
<listitem><simpara>SCALE</simpara></listitem>
97
-
<listitem><simpara>RADIX</simpara></listitem>
98
-
<listitem><simpara>NULLABLE</simpara></listitem>
99
-
<listitem><simpara>REMARKS</simpara></listitem>
83
+
<listitem><simpara><literal>PROCEDURE_CAT</literal></simpara></listitem>
84
+
<listitem><simpara><literal>PROCEDURE_SCHEM</literal></simpara></listitem>
85
+
<listitem><simpara><literal>PROCEDURE_NAME</literal></simpara></listitem>
86
+
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
87
+
<listitem><simpara><literal>COLUMN_TYPE</literal></simpara></listitem>
88
+
<listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>
89
+
<listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>
90
+
<listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>
91
+
<listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>
92
+
<listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>
93
+
<listitem><simpara><literal>NUM_PREC_RADIX</literal></simpara></listitem>
94
+
<listitem><simpara><literal>NULLABLE</literal></simpara></listitem>
95
+
<listitem><simpara><literal>REMARKS</literal></simpara></listitem>
96
+
<listitem><simpara><literal>COLUMN_DEF</literal></simpara></listitem>
97
+
<listitem><simpara><literal>SQL_DATA_TYPE</literal></simpara></listitem>
98
+
<listitem><simpara><literal>SQL_DATETIME_SUB</literal></simpara></listitem>
99
+
<listitem><simpara><literal>CHAR_OCTET_LENGTH</literal></simpara></listitem>
100
+
<listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>
101
+
<listitem><simpara><literal>IS_NULLABLE</literal></simpara></listitem>
100
102
</itemizedlist>
103
+
&odbc.result.driver-specific;
101
104
</para>
102
105
<simpara>
103
-
The result set is ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER,
104
-
PROCEDURE_NAME and COLUMN_TYPE.
106
+
The result set is ordered by <literal>PROCEDURE_CAT</literal>, <literal>PROCEDURE_SCHEM</literal>,
107
+
<literal>PROCEDURE_NAME</literal> and <literal>COLUMN_TYPE</literal>.
105
108
</simpara>
106
109
</refsect1>
107
110

108
-
</refentry>
111
+
<refsect1 role="changelog">
112
+
&reftitle.changelog;
113
+
<informaltable>
114
+
<tgroup cols="2">
115
+
<thead>
116
+
<row>
117
+
<entry>&Version;</entry>
118
+
<entry>&Description;</entry>
119
+
</row>
120
+
</thead>
121
+
<tbody>
122
+
<row>
123
+
<entry>8.0.0</entry>
124
+
<entry>
125
+
Prior to this version, the function could only be called with either one
126
+
or five arguments.
127
+
</entry>
128
+
</row>
129
+
</tbody>
130
+
</tgroup>
131
+
</informaltable>
132
+
</refsect1>
133
+

134
+
<refsect1 role="examples">
135
+
&reftitle.examples;
136
+
<example xml:id="odbc-procedurecolumns.example.basic">
137
+
<title>List Columns of a stored Procedure</title>
138
+
<programlisting role="php">
139
+
<![CDATA[
140
+
<?php
141
+
$conn = odbc_connect($dsn, $user, $pass);
142
+
$columns = odbc_procedurecolumns($conn, 'TutorialDB', 'dbo', 'GetEmployeeSalesYTD;1', '%');
143
+
while (($row = odbc_fetch_array($columns))) {
144
+
print_r($row);
145
+
break; // further rows omitted for brevity
146
+
}
147
+
?>
148
+
]]>
149
+
</programlisting>
150
+
&example.outputs.similar;
151
+
<screen>
152
+
<![CDATA[
153
+
Array
154
+
(
155
+
[PROCEDURE_CAT] => TutorialDB
156
+
[PROCEDURE_SCHEM] => dbo
157
+
[PROCEDURE_NAME] => GetEmployeeSalesYTD;1
158
+
[COLUMN_NAME] => @SalesPerson
159
+
[COLUMN_TYPE] => 1
160
+
[DATA_TYPE] => -9
161
+
[TYPE_NAME] => nvarchar
162
+
[COLUMN_SIZE] => 50
163
+
[BUFFER_LENGTH] => 100
164
+
[DECIMAL_DIGITS] =>
165
+
[NUM_PREC_RADIX] =>
166
+
[NULLABLE] => 1
167
+
[REMARKS] =>
168
+
[COLUMN_DEF] =>
169
+
[SQL_DATA_TYPE] => -9
170
+
[SQL_DATETIME_SUB] =>
171
+
[CHAR_OCTET_LENGTH] => 100
172
+
[ORDINAL_POSITION] => 1
173
+
[IS_NULLABLE] => YES
174
+
)
175
+
]]>
176
+
</screen>
177
+
</example>
178
+
</refsect1>
109
179

180
+
<refsect1 role="seealso">
181
+
&reftitle.seealso;
182
+
<para>
183
+
<simplelist>
184
+
<member><function>odbc_columns</function></member>
185
+
</simplelist>
186
+
</para>
187
+
</refsect1>
188
+

189
+
</refentry>
110
190
<!-- Keep this comment at the end of the file
111
191
Local variables:
112
192
mode: sgml
113
193



Tools (Spanish Manual)