<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>List FrontBase result fields</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-list-dbs.html">fbsql_list_dbs</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-list-tables.html">fbsql_list_tables</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.fbsql-list-fields" class="refentry">
<div class="refnamediv">
<h1 class="refname">fbsql_list_fields</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">fbsql_list_fields</span> — <span class="dc-title">List FrontBase result fields</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fbsql-list-fields-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>fbsql_list_fields</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$database_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$table_name</code></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code></span>
] )</div>
<p class="para rdfs-comment">
Retrieves information about the given table.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fbsql-list-fields-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">database_name</code></dt>
<dd>
<p class="para">
The database name.
</p>
</dd>
<dt>
<code class="parameter">table_name</code></dt>
<dd>
<p class="para">
The table name.
</p>
</dd>
<dt>
<code class="parameter">
link_identifier</code></dt>
<dd>
<p class="para">A FrontBase link identifier
returned by <span class="function"><a href="function.fbsql-connect.html" class="function">fbsql_connect()</a></span> or
<span class="function"><a href="function.fbsql-pconnect.html" class="function">fbsql_pconnect()</a></span>.</p><p class="para">If optional and not specified,
the function will try to find an open link to the FrontBase server and if no
such link is found it will try to create one as if
<span class="function"><a href="function.fbsql-connect.html" class="function">fbsql_connect()</a></span> was called with no arguments.</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fbsql-list-fields-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a result pointer which can be used with the
<em>fbsql_field_xxx</em> functions, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.fbsql-list-fields-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
A string describing the error will be placed in
<em>$phperrmsg</em>, and unless the function was called as
<em>@fbsql()</em> then this error string will also be printed
out.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.fbsql-list-fields-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1253">
<p><strong>Example #1 <span class="function"><strong>fbsql_list_fields()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">fbsql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'myname'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fields </span><span style="color: #007700">= </span><span style="color: #0000BB">fbsql_list_fields</span><span style="color: #007700">(</span><span style="color: #DD0000">"database1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"table1"</span><span style="color: #007700">, </span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$columns </span><span style="color: #007700">= </span><span style="color: #0000BB">fbsql_num_fields</span><span style="color: #007700">(</span><span style="color: #0000BB">$fields</span><span style="color: #007700">);<br /><br />for (</span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">< </span><span style="color: #0000BB">$columns</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br /> echo </span><span style="color: #0000BB">fbsql_field_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$fields</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
field1
field2
field3
...
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.fbsql-list-fields-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="function.fbsql-field-len.html" class="function" rel="rdfs-seeAlso">fbsql_field_len()</a> - Returns the length of the specified field</span></li>
<li class="member"><span class="function"><a href="function.fbsql-field-name.html" class="function" rel="rdfs-seeAlso">fbsql_field_name()</a> - Get the name of the specified field in a result</span></li>
<li class="member"><span class="function"><a href="function.fbsql-field-type.html" class="function" rel="rdfs-seeAlso">fbsql_field_type()</a> - Get the type of the specified field in a result</span></li>
<li class="member"><span class="function"><a href="function.fbsql-field-flags.html" class="function" rel="rdfs-seeAlso">fbsql_field_flags()</a> - Get the flags associated with the specified field in a result</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-list-dbs.html">fbsql_list_dbs</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-list-tables.html">fbsql_list_tables</a></div>
<div class="up"><a href="ref.fbsql.html">FrontBase Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
