1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.odbc-procedurecolumns" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>odbc_procedurecolumns</refname>
<refpurpose>Retrieve information about parameters to procedures</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>Odbc\Result</type><type>false</type></type><methodname>odbc_procedurecolumns</methodname>
<methodparam><type>Odbc\Connection</type><parameter>odbc</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>catalog</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>procedure</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>column</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Retrieve information about parameters to procedures.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>odbc</parameter></term>
<listitem>
&odbc.connection.id;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>catalog</parameter></term>
<listitem>
<para>
&odbc.parameter.catalog;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>schema</parameter></term>
<listitem>
<para>
&odbc.parameter.schema;
&odbc.parameter.search;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>procedure</parameter></term>
<listitem>
<para>
The proc.
&odbc.parameter.search;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>column</parameter></term>
<listitem>
<para>
The column.
&odbc.parameter.search;
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the list of input and output parameters, as well as the
columns that make up the result set for the specified procedures.
&odbc.result.object-return-falseforfailure;
</para>
<para>
The result set has the following columns:
<itemizedlist>
<listitem><simpara><literal>PROCEDURE_CAT</literal></simpara></listitem>
<listitem><simpara><literal>PROCEDURE_SCHEM</literal></simpara></listitem>
<listitem><simpara><literal>PROCEDURE_NAME</literal></simpara></listitem>
<listitem><simpara><literal>COLUMN_NAME</literal></simpara></listitem>
<listitem><simpara><literal>COLUMN_TYPE</literal></simpara></listitem>
<listitem><simpara><literal>DATA_TYPE</literal></simpara></listitem>
<listitem><simpara><literal>TYPE_NAME</literal></simpara></listitem>
<listitem><simpara><literal>COLUMN_SIZE</literal></simpara></listitem>
<listitem><simpara><literal>BUFFER_LENGTH</literal></simpara></listitem>
<listitem><simpara><literal>DECIMAL_DIGITS</literal></simpara></listitem>
<listitem><simpara><literal>NUM_PREC_RADIX</literal></simpara></listitem>
<listitem><simpara><literal>NULLABLE</literal></simpara></listitem>
<listitem><simpara><literal>REMARKS</literal></simpara></listitem>
<listitem><simpara><literal>COLUMN_DEF</literal></simpara></listitem>
<listitem><simpara><literal>SQL_DATA_TYPE</literal></simpara></listitem>
<listitem><simpara><literal>SQL_DATETIME_SUB</literal></simpara></listitem>
<listitem><simpara><literal>CHAR_OCTET_LENGTH</literal></simpara></listitem>
<listitem><simpara><literal>ORDINAL_POSITION</literal></simpara></listitem>
<listitem><simpara><literal>IS_NULLABLE</literal></simpara></listitem>
</itemizedlist>
&odbc.result.driver-specific;
</para>
<simpara>
The result set is ordered by <literal>PROCEDURE_CAT</literal>, <literal>PROCEDURE_SCHEM</literal>,
<literal>PROCEDURE_NAME</literal> and <literal>COLUMN_TYPE</literal>.
</simpara>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&odbc.changelog.connection-param;
&odbc.changelog.result-return;
<row>
<entry>8.0.0</entry>
<entry>
Prior to this version, the function could only be called with either one
or five arguments.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="odbc-procedurecolumns.example.basic">
<title>List Columns of a stored Procedure</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = odbc_connect($dsn, $user, $pass);
$columns = odbc_procedurecolumns($conn, 'TutorialDB', 'dbo', 'GetEmployeeSalesYTD;1', '%');
while (($row = odbc_fetch_array($columns))) {
print_r($row);
break; // further rows omitted for brevity
}
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Array
(
[PROCEDURE_CAT] => TutorialDB
[PROCEDURE_SCHEM] => dbo
[PROCEDURE_NAME] => GetEmployeeSalesYTD;1
[COLUMN_NAME] => @SalesPerson
[COLUMN_TYPE] => 1
[DATA_TYPE] => -9
[TYPE_NAME] => nvarchar
[COLUMN_SIZE] => 50
[BUFFER_LENGTH] => 100
[DECIMAL_DIGITS] =>
[NUM_PREC_RADIX] =>
[NULLABLE] => 1
[REMARKS] =>
[COLUMN_DEF] =>
[SQL_DATA_TYPE] => -9
[SQL_DATETIME_SUB] =>
[CHAR_OCTET_LENGTH] => 100
[ORDINAL_POSITION] => 1
[IS_NULLABLE] => YES
)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>odbc_columns</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:"~/.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
-->
|
