reference/uodbc/functions/odbc-procedures.xml
902c2b77f827e8d0ecccf4f62fb90065d2f6ef79
...
...
@@ -9,15 +9,11 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
-
<type>resource</type><methodname>odbc_procedures</methodname>
13
-
<methodparam><type>resource</type><parameter>connection_id</parameter></methodparam>
14
-
</methodsynopsis>
15
-
<methodsynopsis>
16
-
<type>resource</type><methodname>odbc_procedures</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>name</parameter></methodparam>
12
+
<type class="union"><type>resource</type><type>false</type></type><methodname>odbc_procedures</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>
21
17
</methodsynopsis>
22
18
<para>
23
19
Lists all procedures in the requested range.
...
...
@@ -29,30 +25,30 @@
29
25
<para>
30
26
<variablelist>
31
27
<varlistentry>
32
-
<term><parameter>connection_id</parameter></term>
28
+
<term><parameter>odbc</parameter></term>
33
29
<listitem>
34
30
&odbc.connection.id;
35
31
</listitem>
36
32
</varlistentry>
37
33
<varlistentry>
38
-
<term><parameter>qualifier</parameter></term>
34
+
<term><parameter>catalog</parameter></term>
39
35
<listitem>
40
36
<para>
41
-
The qualifier.
37
+
&odbc.parameter.catalog;
42
38
</para>
43
39
</listitem>
44
40
</varlistentry>
45
41
<varlistentry>
46
-
<term><parameter>owner</parameter></term>
42
+
<term><parameter>schema</parameter></term>
47
43
<listitem>
48
44
<para>
49
-
The owner.
45
+
&odbc.parameter.schema;
50
46
&odbc.parameter.search;
51
47
</para>
52
48
</listitem>
53
49
</varlistentry>
54
50
<varlistentry>
55
-
<term><parameter>name</parameter></term>
51
+
<term><parameter>procedure</parameter></term>
56
52
<listitem>
57
53
<para>
58
54
The name.
...
...
@@ -73,20 +69,92 @@
73
69
<para>
74
70
The result set has the following columns:
75
71
<itemizedlist>
76
-
<listitem><simpara>PROCEDURE_QUALIFIER</simpara></listitem>
77
-
<listitem><simpara>PROCEDURE_OWNER</simpara></listitem>
78
-
<listitem><simpara>PROCEDURE_NAME</simpara></listitem>
79
-
<listitem><simpara>NUM_INPUT_PARAMS</simpara></listitem>
80
-
<listitem><simpara>NUM_OUTPUT_PARAMS</simpara></listitem>
81
-
<listitem><simpara>NUM_RESULT_SETS</simpara></listitem>
82
-
<listitem><simpara>REMARKS</simpara></listitem>
83
-
<listitem><simpara>PROCEDURE_TYPE</simpara></listitem>
72
+
<listitem><simpara><literal>PROCEDURE_CAT</literal></simpara></listitem>
73
+
<listitem><simpara><literal>PROCEDURE_SCHEM</literal></simpara></listitem>
74
+
<listitem><simpara><literal>PROCEDURE_NAME</literal></simpara></listitem>
75
+
<listitem><simpara><literal>NUM_INPUT_PARAMS</literal></simpara></listitem>
76
+
<listitem><simpara><literal>NUM_OUTPUT_PARAMS</literal></simpara></listitem>
77
+
<listitem><simpara><literal>NUM_RESULT_SETS</literal></simpara></listitem>
78
+
<listitem><simpara><literal>REMARKS</literal></simpara></listitem>
79
+
<listitem><simpara><literal>PROCEDURE_TYPE</literal></simpara></listitem>
84
80
</itemizedlist>
81
+
&odbc.result.driver-specific;
85
82
</para>
83
+
<simpara>
84
+
The result set is ordered by <literal>PROCEDURE_CAT</literal>,
85
+
<literal>PROCEDURE_SCHEMA</literal> and <literal>PROCEDURE_NAME</literal>.
86
+
</simpara>
86
87
</refsect1>
87
88

88
-
</refentry>
89
+
<refsect1 role="changelog">
90
+
&reftitle.changelog;
91
+
<informaltable>
92
+
<tgroup cols="2">
93
+
<thead>
94
+
<row>
95
+
<entry>&Version;</entry>
96
+
<entry>&Description;</entry>
97
+
</row>
98
+
</thead>
99
+
<tbody>
100
+
<row>
101
+
<entry>8.0.0</entry>
102
+
<entry>
103
+
Prior to this version, the function could only be called with either one
104
+
or four arguments.
105
+
</entry>
106
+
</row>
107
+
</tbody>
108
+
</tgroup>
109
+
</informaltable>
110
+
</refsect1>
111
+

112
+
<refsect1 role="examples">
113
+
&reftitle.examples;
114
+
<example xml:id="odbc-procedures.example.basic">
115
+
<title>List stored Procedures of a Database</title>
116
+
<programlisting role="php">
117
+
<![CDATA[
118
+
<?php
119
+
$conn = odbc_connect($dsn, $user, $pass);
120
+
$procedures = odbc_procedures($conn, $catalog, $schema, '%');
121
+
while (($row = odbc_fetch_array($procedures))) {
122
+
print_r($row);
123
+
break; // further rows omitted for brevity
124
+
}
125
+
?>
126
+
]]>
127
+
</programlisting>
128
+
&example.outputs.similar;
129
+
<screen>
130
+
<![CDATA[
131
+
Array
132
+
(
133
+
[PROCEDURE_CAT] => TutorialDB
134
+
[PROCEDURE_SCHEM] => dbo
135
+
[PROCEDURE_NAME] => GetEmployeeSalesYTD;1
136
+
[NUM_INPUT_PARAMS] => -1
137
+
[NUM_OUTPUT_PARAMS] => -1
138
+
[NUM_RESULT_SETS] => -1
139
+
[REMARKS] =>
140
+
[PROCEDURE_TYPE] => 2
141
+
)
142
+
]]>
143
+
</screen>
144
+
</example>
145
+
</refsect1>
89
146

147
+
<refsect1 role="seealso">
148
+
&reftitle.seealso;
149
+
<para>
150
+
<simplelist>
151
+
<member><function>odbc_procedurecolumns</function></member>
152
+
<member><function>odbc_tables</function></member>
153
+
</simplelist>
154
+
</para>
155
+
</refsect1>
156
+

157
+
</refentry>
90
158
<!-- Keep this comment at the end of the file
91
159
Local variables:
92
160
mode: sgml
93
161



Tools (Spanish Manual)