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
|
<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0-subset Scilab" xml:id="mysql_list_fields" xml:lang="en"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1999/xhtml"
xmlns:mml="http://www.w3.org/1998/Math/MathML"
xmlns:db="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mysql_list_fields</refname>
<refpurpose>Returns a result set consisting of field names in the given table.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>mysql_res = mysql_list_fields(mysql, table, wild)</synopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>Returns a result set consisting of field names
in the given table that match the simple regular
expression specified by the wild parameter.</para>
<para><literal>wild</literal> may contain the wildcard
characters “%” or “_”, or may be empty to match all fields.</para>
<para>Calling <literal>mysql_list_fields</literal> is similar
to executing the query <literal>SHOW COLUMNS FROM tbl_name [LIKE wild]</literal>.</para>
<para>It is preferable to use <literal>SHOW COLUMNS FROM tbl_name</literal>
instead of <literal>mysql_list_fields</literal>.</para>
<para>You must free the result set with <literal>mysql_free_result</literal>.</para>
</refsection>
<refsection>
<title>Parameters</title>
<variablelist>
<varlistentry>
<term>mysql</term>
<listitem>
<para>a MySQL pointer</para>
</listitem>
</varlistentry>
<varlistentry>
<term>table</term>
<listitem>
<para>the name of the table</para>
</listitem>
</varlistentry>
<varlistentry>
<term>wild</term>
<listitem>
<para>a wildchar expression</para>
</listitem>
</varlistentry>
<varlistentry>
<term>mysql_res</term>
<listitem>
<para>A MYSQL_RES result set for success. Empty if an error occurred.</para>
<itemizedlist>
<listitem>
<para>CR_COMMANDS_OUT_OF_SYNC Commands were executed in
an improper order.</para>
</listitem>
<listitem>
<para>CR_SERVER_GONE_ERROR The MySQL server has gone
away.</para>
</listitem>
<listitem>
<para>CR_SERVER_LOST The connection to the server was
lost during the query.</para>
</listitem>
<listitem>
<para>CR_UNKNOWN_ERROR An unknown error occurred.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
username = 'glpk'; // Put your username
password = 'gnu'; // Put your password
database = 'glpk';
port = 3306; // use netstat -a | grep mysql to locate the mysql port
// or ps -elf | grep mysql and locate --port
myhost = 'localhost'; // localhost most of the time
sql_ptr = mysql_init();
status = mysql_real_connect(sql_ptr, myhost, username, password, database, port);
sql_res_ptr = mysql_list_fields(sql_ptr, 'sudoku','%');
mysql_close(sql_ptr);
]]></programlisting>
</refsection>
<refsection>
<title>See Also</title>
<simplelist type="inline">
<member><link linkend="mysql_init">mysql_init</link></member>
<member><link linkend="mysql_real_connect">mysql_real_connect</link></member>
<member><link linkend="mysql_close">mysql_close</link></member>
</simplelist>
</refsection>
<refsection>
<title>Authors</title>
<simplelist type="vert">
<member>Yann COLLETTE</member>
</simplelist>
</refsection>
</refentry>
|
