File: maxdb-real-connect.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (162 lines) | stat: -rw-r--r-- 4,966 bytes parent folder | download | duplicates (2)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
  <refentry id="function.maxdb-real-connect">
   <refnamediv>
    <refname>maxdb_real_connect</refname>
    <refname>maxdb->real_connect</refname>
    <refpurpose>Opens a connection to a MaxDB server</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <para>Procedural style</para>
     <methodsynopsis>
      <type>bool</type><methodname>maxdb_real_connect</methodname>
      <methodparam><type>resource</type><parameter>link</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
      <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
      <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
     </methodsynopsis>
     <para>Object oriented style (method)</para>
     <classsynopsis>
      <ooclass><classname>maxdb</classname></ooclass>
      <methodsynopsis>
       <type>bool</type>
       <methodname>real_connect</methodname>
       <methodparam choice='opt'><type>string</type><parameter>hostname</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>username</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>passwd</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>dbname</parameter></methodparam>
       <methodparam choice='opt'><type>int</type><parameter>port</parameter></methodparam>
       <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam>
      </methodsynopsis>
     </classsynopsis>
    <para>
     <function>maxdb_real_connect</function> attempts to establish a
     connection to a MaxDB database engine running on
     <parameter>hostname</parameter>. 
    </para> 
    <para>
     This function differs from <function>maxdb_connect</function>:
    </para>
    <itemizedlist>
     <listitem>
      <para>
       <function>maxdb_real_connect</function> needs a valid resource which has
       to be created by function <function>maxdb_init</function>
      </para>
     </listitem>
     <listitem>
      <para>
       With function <function>maxdb_options</function> you can set various options for connection.
      </para>
     </listitem>
    </itemizedlist>
   </refsect1>
   <refsect1>
    &reftitle.returnvalues;
    <para>&return.success;</para>
   </refsect1>
   <refsect1>
    &reftitle.seealso;
    <para>
     <function>maxdb_connect</function>,
     <function>maxdb_init</function>,
     <function>maxdb_options</function>,
     <function>maxdb_ssl_set</function>,
     <function>maxdb_close</function>.
    </para>
   </refsect1>
   <refsect1>
    <title>Example</title>
    <example>
     <title>Object oriented style</title>
     <programlisting role="php">
<![CDATA[
<?php

/* create a connection object which is not connected */
$maxdb = maxdb_init();

/* set connection options */
$maxdb->options(MAXDB_UNICODE, "FALSE");
$maxdb->options(MAXDB_TIMEOUT, 5);

/* connect to server */
$maxdb->real_connect('localhost', 'MONA', 'RED', 'DEMODB');

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

printf ("Connection: %s\n.", $maxdb->host_info);

$maxdb->close();
?>
]]>
    </programlisting>
    </example>
    <example>
     <title>Procedural style</title>
     <programlisting role="php">
<![CDATA[
<?php

/* create a connection object which is not connected */
$link = maxdb_init();

/* set connection options */
maxdb_options($link, MAXDB_UNICODE, "FALSE");
maxdb_options($link, MAXDB_TIMEOUT, 5);

/* connect to server */
maxdb_real_connect($link, 'localhost', 'MONA', 'RED', 'DEMODB');

/* check connection */
if (maxdb_connect_errno()) {
   printf("Connect failed: %s\n", maxdb_connect_error());
   exit();
}

printf ("Connection: %s\n.", maxdb_get_host_info($link));

maxdb_close($link);
?>
]]>
     </programlisting>
    </example>
    <para>
     The above examples would produce the following output:
    </para>
    <screen>
<![CDATA[
Connection: localhost <...>
]]>
    </screen>
   </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
-->