php-doc-en/reference/mssql/functions/mssql-select-db.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mssql-select-db" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>mssql_select_db</refname>
  <refpurpose>Select MS SQL database</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>mssql_select_db</methodname>
   <methodparam><type>string</type><parameter>database_name</parameter></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>link_identifier</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>mssql_select_db</function> sets the current active
   database on the server that's associated with the specified link
   identifier.
  </para>
  <para>
   Every subsequent call to <function>mssql_query</function> will be
   made on the active database.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>database_name</parameter></term>
     <listitem>
      <para>
       The database name.
      </para>
      <para>
       To escape the name of a database that contains spaces, hyphens ("-"),
       or any other exceptional characters, the database name must be
       enclosed in brackets, as is shown in the example, below. This
       technique must also be applied when selecting a database name that is
       also a reserved word (such as <literal>primary</literal>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>link_identifier</parameter></term>
     <listitem>
      <para>
       A MS SQL link identifier, returned by
       <function>mssql_connect</function> or
       <function>mssql_pconnect</function>.
      </para>
      <para>
       If no link identifier is specified, the last opened link is assumed.
       If no link is open, the function will try to establish a link as if
       <function>mssql_connect</function> was called, and use it.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example xml:id="mssql.mssql-select-db.example.basic">
    <title><function>mssql_select_db</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// Create a link to MSSQL
$link = mssql_connect('KALLESPC\SQLEXPRESS', 'sa', 'phpfi');

// Select the database 'php'
mssql_select_db('php', $link);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example xml:id="mssql.mssql-select-db.example.escape">
    <title>Escaping the database name with square brackets</title>
    <programlisting role="php">
<![CDATA[
<?php
// Create a link to MSSQL
$link = mssql_connect('KALLESPC\SQLEXPRESS', 'sa', 'phpfi');

// Select the database 'my.database-name'
mssql_select_db('[my.database-name]', $link);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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