File: ingres-connect.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (102 lines) | stat: -rw-r--r-- 3,099 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ingres_ii.xml, last change in rev 1.1 -->
  <refentry id="function.ingres-connect">
   <refnamediv>
    <refname>ingres_connect</refname> 
    <refpurpose>
     Open a connection to an Ingres II database
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>resource</type><methodname>ingres_connect</methodname>
      <methodparam choice="opt"><type>string</type><parameter>database</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>username</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
     </methodsynopsis>
    &warn.experimental.func;
    <para>
     Returns a Ingres II link resource on success, or &false; on
     failure.
    </para>
    <para>
     <function>ingres_connect</function> opens a connection with the
     Ingres database designated by <parameter>database</parameter>,
     which follows the syntax
     <parameter>[node_id::]dbname[/svr_class]</parameter>.
    </para>
    <para>
     If some parameters are missing, <function>ingres_connect</function>
     uses the values in &php.ini; for
     <parameter>ingres.default_database</parameter>,
     <parameter>ingres.default_user</parameter>, and
     <parameter>ingres.default_password</parameter>.
    </para>
    <para>
     The connection is closed when the script ends or when
     <function>ingres_close</function> is called on this link.
    </para>
    <para>
     All the other ingres functions use the last opened link as a
     default, so you need to store the returned value only if you use
     more than one link at a time.
    </para>
    <para>
     <example>
      <title><function>ingres_connect</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
    $link = ingres_connect("mydb", "user", "pass")
        or die("Could not connect");
    echo "Connected successfully";
    ingres_close($link);
?>
]]>
      </programlisting>
     </example>
     <example>
      <title>
       <function>ingres_connect</function> example using default link
      </title>
      <programlisting role="php">
<![CDATA[
<?php
    ingres_connect("mydb", "user", "pass")
        or die("Could not connect");
    echo "Connected successfully";
    ingres_close();
?>
]]>
      </programlisting>
     </example>
    </para>
    <para> See also
     <function>ingres_pconnect</function> and
     <function>ingres_close</function>.
    </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:"../../../../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
-->