php-doc-en/reference/cubrid/functions/cubrid-connect.xml
2010-09-08 01:27:51 +00:00

123 lines
3.7 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.cubrid-connect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>cubrid_connect</refname>
<refpurpose>Is used to establish the environment for connecting to your server </refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>cubrid_connect</methodname>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam><type>string</type><parameter>dbname</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>userid</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>passwd</parameter></methodparam>
</methodsynopsis>
<para>
The <function>cubrid_connect</function> function is used to establish the environment for connecting to your server by using your server address, port number, database name, user name, and password. If the user name and password is not given, then the "PUBLIC" connection will be made by default.
</para>
<para>
Calling the <function>cubrid_connect</function> function does not necessarily make the connection to your server. The actual connection will be made when an operation is requested by using the connection handle.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para>Host name or IP address of CAS server.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem><para>Port number of CAS server (BROKER_PORT configured in $CUBRID/conf/cubrid_broker.conf).</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>dbname</parameter></term>
<listitem><para>Name of database.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>userid</parameter></term>
<listitem><para>User name for the database.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>passwd</parameter></term>
<listitem><para>User password.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Connection identifier, when process is successful.
</para>
<para>
&false;, when process is unsuccessful.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>cubrid_connect</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$con = cubrid_connect ("210.211.133.100", 12345, "demodb");
if ($con) {
echo "connected successfully";
$req =cubrid_execute($con, "insert into person values(1,James)");
if ($req) {
cubrid_close_request ($req);
cubrid_commit ($con);
} else {
cubrid_rollback ($con);
}
cubrid_disconnect ($con);
}
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cubrid_disconnect</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
-->