<!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 databases available on a FrontBase server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.fbsql-insert-id.html">fbsql_insert_id</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-list-fields.html">fbsql_list_fields</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-dbs" class="refentry">
<div class="refnamediv">
<h1 class="refname">fbsql_list_dbs</h1>
<p class="verinfo">(PHP 4 >= 4.0.6, PHP 5)</p><p class="refpurpose"><span class="refname">fbsql_list_dbs</span> — <span class="dc-title">List databases available on a FrontBase server</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.fbsql-list-dbs-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">resource</span> <span class="methodname"><strong>fbsql_list_dbs</strong></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code></span>
] )</div>
<p class="para rdfs-comment">
Return a result pointer containing the databases available from the
current fbsql daemon. Use the <span class="function"><a href="function.fbsql-tablename.html" class="function">fbsql_tablename()</a></span> to
traverse this result pointer.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.fbsql-list-dbs-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">
link_identifier</code></em></span><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>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.fbsql-list-dbs-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a result pointer or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.fbsql-list-dbs-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-1129">
<p><strong>Example #1 <span class="function"><strong>fbsql_list_dbs()</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 /></span><span style="color: #0000BB">$db_list </span><span style="color: #007700">= </span><span style="color: #0000BB">fbsql_list_dbs</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$row </span><span style="color: #007700">= </span><span style="color: #0000BB">fbsql_fetch_object</span><span style="color: #007700">(</span><span style="color: #0000BB">$db_list</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #0000BB">$row</span><span style="color: #007700">-></span><span style="color: #0000BB">Database </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>
database1
database2
database3
...
</pre></div>
</div>
</div>
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
The above code would just as easily work with
<span class="function"><a href="function.fbsql-fetch-row.html" class="function">fbsql_fetch_row()</a></span> or other similar functions.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.fbsql-list-dbs-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.fbsql-list-fields.html" class="function" rel="rdfs-seeAlso">fbsql_list_fields()</a> - List FrontBase result fields</span></li>
<li class="member"> <span class="function"><a href="function.fbsql-list-tables.html" class="function" rel="rdfs-seeAlso">fbsql_list_tables()</a> - List tables in a FrontBase database</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-insert-id.html">fbsql_insert_id</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.fbsql-list-fields.html">fbsql_list_fields</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>
