<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fbsql-db-status" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fbsql_db_status</refname>
  <refpurpose>Get the status for a given database</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>fbsql_db_status</methodname>
   <methodparam><type>string</type><parameter>database_name</parameter></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets the current status of the specified database.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database_name</parameter></term>
     <listitem>
      <para>
       The database name.
      </para>
     </listitem>
    </varlistentry>
    &fbsql.link-identifier.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an integer value with the current status. This can be one of the
   following constants:
   <itemizedlist>
    <listitem>
     <simpara>
      &false; - The exec handler for the host was invalid. This error will
      occur when the <parameter>link_identifier</parameter> connects directly
      to a database by using a port number. FBExec can be available on the
      server but no connection has been made for it.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>FBSQL_UNKNOWN</constant> - The Status is unknown.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>FBSQL_STOPPED</constant> - The database is not running. Use
      <function>fbsql_start_db</function> to start the database.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>FBSQL_STARTING</constant> - The database is starting.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>FBSQL_RUNNING</constant> - The database is running and can be
      used to perform SQL operations.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>FBSQL_STOPPING</constant> - The database is stopping.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>FBSQL_NOEXEC</constant> - FBExec is not running on the server
      and it is not possible to get the status of the database.
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fbsql_start_db</function></member>
    <member><function>fbsql_stop_db</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
-->