php-doc-en/reference/sybase/functions/sybase-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.sybase-connect">
 <refnamediv>
  <refname>sybase_connect</refname>
  <refpurpose>Opens a Sybase server connection</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>sybase_connect</methodname>
   <methodparam choice="opt"><type>string</type><parameter>servername</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>appname</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>new</parameter><initializer>false</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>sybase_connect</function> establishes a connection to a
   Sybase server. 
  </para>
  <para>
   In case a second call is made to
   <function>sybase_connect</function> with the same arguments, no
   new link will be established, but instead, the link identifier of
   the already opened link will be returned.
  </para>
  <para>
   The link to the server will be closed as soon as the
   execution of the script ends, unless it's closed earlier by
   explicitly calling <function>sybase_close</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>servername</parameter></term>
     <listitem>
      <para>
       The servername argument has to be a valid servername that is defined
       in the 'interfaces' file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>username</parameter></term>
     <listitem>
      <para>
       Sybase user name
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>password</parameter></term>
     <listitem>
      <para>
       Password associated with <parameter>username</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       Specifies the charset for the connection
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>appname</parameter></term>
     <listitem>
      <para>
       Specifies an <literal>appname</literal> for the Sybase connection.
       This allow you to make separate connections in the same script to the
       same database. This may come handy when you have started a transaction
       in your current connection, and you need to be able to do a separate
       query which cannot be performed inside this transaction.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new</parameter></term>
     <listitem>
      <para>
       Whether to open a new connection or use the existing one.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a positive Sybase link identifier on success, or &false; on
   failure.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.0</entry>
       <entry>
        The <parameter>new</parameter> parameter was added.
       </entry>
      </row>
      <row>
       <entry>4.2.0</entry>
       <entry>
        The <parameter>appname</parameter> parameter was added.
       </entry>
      </row>
      <row>
       <entry>4.0.2</entry>
       <entry>
        The <parameter>charset</parameter> parameter was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>sybase_connect</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$link = sybase_connect('SYBASE', '', '')
        or die("Could not connect !");
echo "Connected successfully";
sybase_close($link);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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