Author: paul
Date: 2008-10-01 19:21:49 +0200 (Wed, 01 Oct 2008)
New Revision: 11937
Log:
r34357@frost: paul | 2008-10-01 09:18:00 -0500
Some mysql_library_init() tweaks
Modified:
trunk/refman-4.1/apis-c.xml
trunk/refman-5.0/apis-c.xml
trunk/refman-5.1/apis-c.xml
trunk/refman-6.0/apis-c.xml
Property changes on: trunk
___________________________________________________________________
Name: svk:merge
- 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:34354
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:33355
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:35828
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:34357
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:33355
Modified: trunk/refman-4.1/apis-c.xml
===================================================================
--- trunk/refman-4.1/apis-c.xml 2008-10-01 17:16:08 UTC (rev 11936)
+++ trunk/refman-4.1/apis-c.xml 2008-10-01 17:21:49 UTC (rev 11937)
Changed blocks: 2, Lines Added: 18, Lines Deleted: 12; 2744 bytes
@@ -4217,11 +4217,11 @@
</para>
<para>
- The choice of whether the application acts as a regular client
- or uses the embedded server depends on whether you use the
- <literal>libmysqlclient</literal> or
- <literal>libmysqld</literal> at link time to produce the final
- executable. For additional information, see
+ The choice of whether the application operates as a regular
+ client or uses the embedded server depends on whether you use
+ the <literal>libmysqlclient</literal> or
+ <literal>libmysqld</literal> library at link time to produce the
+ final executable. For additional information, see
<xref linkend="c-api-function-overview"/>.
</para>
@@ -4247,21 +4247,27 @@
The <literal>argc</literal> and <literal>argv</literal>
arguments are analogous to the arguments to
<literal>main()</literal>, and enable passing of options to the
- embedded server. The first element of <literal>argv</literal> is
- ignored (it typically contains the program name).
- <function role="capi">mysql_library_init()</function> makes a
- copy of the arguments so it is safe to destroy
- <literal>argv</literal> or <literal>groups</literal> after the
- call. For convenience, <literal>argc</literal> may be
+ embedded server. For convenience, <literal>argc</literal> may be
<literal>0</literal> (zero) if there are no command-line
arguments for the server. This is the usual case for
- non-embedded applications intended for use only as regular
+ applications intended for use only as regular (non-embedded)
clients, and the call typically is written as
<function role="capi">mysql_library_init(0, NULL,
NULL)</function>.
</para>
<para>
+ When arguments are to be passed (<literal>argc</literal> is
+ greater than <literal>0</literal>), the first element of
+ <literal>argv</literal> is ignored (it typically contains the
+ program name).
+ <function role="capi">mysql_library_init()</function> makes a
+ copy of the arguments so it is safe to destroy
+ <literal>argv</literal> or <literal>groups</literal> after the
+ call.
+ </para>
+
+ <para>
For embedded applications, if you want to connect to an external
server without starting the embedded server, you have to specify
a negative value for <literal>argc</literal>.
Modified: trunk/refman-5.0/apis-c.xml
===================================================================
--- trunk/refman-5.0/apis-c.xml 2008-10-01 17:16:08 UTC (rev 11936)
+++ trunk/refman-5.0/apis-c.xml 2008-10-01 17:21:49 UTC (rev 11937)
Changed blocks: 2, Lines Added: 18, Lines Deleted: 12; 2744 bytes
@@ -4367,11 +4367,11 @@
</para>
<para>
- The choice of whether the application acts as a regular client
- or uses the embedded server depends on whether you use the
- <literal>libmysqlclient</literal> or
- <literal>libmysqld</literal> at link time to produce the final
- executable. For additional information, see
+ The choice of whether the application operates as a regular
+ client or uses the embedded server depends on whether you use
+ the <literal>libmysqlclient</literal> or
+ <literal>libmysqld</literal> library at link time to produce the
+ final executable. For additional information, see
<xref linkend="c-api-function-overview"/>.
</para>
@@ -4397,21 +4397,27 @@
The <literal>argc</literal> and <literal>argv</literal>
arguments are analogous to the arguments to
<literal>main()</literal>, and enable passing of options to the
- embedded server. The first element of <literal>argv</literal> is
- ignored (it typically contains the program name).
- <function role="capi">mysql_library_init()</function> makes a
- copy of the arguments so it is safe to destroy
- <literal>argv</literal> or <literal>groups</literal> after the
- call. For convenience, <literal>argc</literal> may be
+ embedded server. For convenience, <literal>argc</literal> may be
<literal>0</literal> (zero) if there are no command-line
arguments for the server. This is the usual case for
- non-embedded applications intended for use only as regular
+ applications intended for use only as regular (non-embedded)
clients, and the call typically is written as
<function role="capi">mysql_library_init(0, NULL,
NULL)</function>.
</para>
<para>
+ When arguments are to be passed (<literal>argc</literal> is
+ greater than <literal>0</literal>), the first element of
+ <literal>argv</literal> is ignored (it typically contains the
+ program name).
+ <function role="capi">mysql_library_init()</function> makes a
+ copy of the arguments so it is safe to destroy
+ <literal>argv</literal> or <literal>groups</literal> after the
+ call.
+ </para>
+
+ <para>
For embedded applications, if you want to connect to an external
server without starting the embedded server, you have to specify
a negative value for <literal>argc</literal>.
Modified: trunk/refman-5.1/apis-c.xml
===================================================================
--- trunk/refman-5.1/apis-c.xml 2008-10-01 17:16:08 UTC (rev 11936)
+++ trunk/refman-5.1/apis-c.xml 2008-10-01 17:21:49 UTC (rev 11937)
Changed blocks: 2, Lines Added: 18, Lines Deleted: 12; 2744 bytes
@@ -4425,11 +4425,11 @@
</para>
<para>
- The choice of whether the application acts as a regular client
- or uses the embedded server depends on whether you use the
- <literal>libmysqlclient</literal> or
- <literal>libmysqld</literal> at link time to produce the final
- executable. For additional information, see
+ The choice of whether the application operates as a regular
+ client or uses the embedded server depends on whether you use
+ the <literal>libmysqlclient</literal> or
+ <literal>libmysqld</literal> library at link time to produce the
+ final executable. For additional information, see
<xref linkend="c-api-function-overview"/>.
</para>
@@ -4455,21 +4455,27 @@
The <literal>argc</literal> and <literal>argv</literal>
arguments are analogous to the arguments to
<literal>main()</literal>, and enable passing of options to the
- embedded server. The first element of <literal>argv</literal> is
- ignored (it typically contains the program name).
- <function role="capi">mysql_library_init()</function> makes a
- copy of the arguments so it is safe to destroy
- <literal>argv</literal> or <literal>groups</literal> after the
- call. For convenience, <literal>argc</literal> may be
+ embedded server. For convenience, <literal>argc</literal> may be
<literal>0</literal> (zero) if there are no command-line
arguments for the server. This is the usual case for
- non-embedded applications intended for use only as regular
+ applications intended for use only as regular (non-embedded)
clients, and the call typically is written as
<function role="capi">mysql_library_init(0, NULL,
NULL)</function>.
</para>
<para>
+ When arguments are to be passed (<literal>argc</literal> is
+ greater than <literal>0</literal>), the first element of
+ <literal>argv</literal> is ignored (it typically contains the
+ program name).
+ <function role="capi">mysql_library_init()</function> makes a
+ copy of the arguments so it is safe to destroy
+ <literal>argv</literal> or <literal>groups</literal> after the
+ call.
+ </para>
+
+ <para>
For embedded applications, if you want to connect to an external
server without starting the embedded server, you have to specify
a negative value for <literal>argc</literal>.
Modified: trunk/refman-6.0/apis-c.xml
===================================================================
--- trunk/refman-6.0/apis-c.xml 2008-10-01 17:16:08 UTC (rev 11936)
+++ trunk/refman-6.0/apis-c.xml 2008-10-01 17:21:49 UTC (rev 11937)
Changed blocks: 2, Lines Added: 18, Lines Deleted: 12; 2744 bytes
@@ -4380,11 +4380,11 @@
</para>
<para>
- The choice of whether the application acts as a regular client
- or uses the embedded server depends on whether you use the
- <literal>libmysqlclient</literal> or
- <literal>libmysqld</literal> at link time to produce the final
- executable. For additional information, see
+ The choice of whether the application operates as a regular
+ client or uses the embedded server depends on whether you use
+ the <literal>libmysqlclient</literal> or
+ <literal>libmysqld</literal> library at link time to produce the
+ final executable. For additional information, see
<xref linkend="c-api-function-overview"/>.
</para>
@@ -4410,21 +4410,27 @@
The <literal>argc</literal> and <literal>argv</literal>
arguments are analogous to the arguments to
<literal>main()</literal>, and enable passing of options to the
- embedded server. The first element of <literal>argv</literal> is
- ignored (it typically contains the program name).
- <function role="capi">mysql_library_init()</function> makes a
- copy of the arguments so it is safe to destroy
- <literal>argv</literal> or <literal>groups</literal> after the
- call. For convenience, <literal>argc</literal> may be
+ embedded server. For convenience, <literal>argc</literal> may be
<literal>0</literal> (zero) if there are no command-line
arguments for the server. This is the usual case for
- non-embedded applications intended for use only as regular
+ applications intended for use only as regular (non-embedded)
clients, and the call typically is written as
<function role="capi">mysql_library_init(0, NULL,
NULL)</function>.
</para>
<para>
+ When arguments are to be passed (<literal>argc</literal> is
+ greater than <literal>0</literal>), the first element of
+ <literal>argv</literal> is ignored (it typically contains the
+ program name).
+ <function role="capi">mysql_library_init()</function> makes a
+ copy of the arguments so it is safe to destroy
+ <literal>argv</literal> or <literal>groups</literal> after the
+ call.
+ </para>
+
+ <para>
For embedded applications, if you want to connect to an external
server without starting the embedded server, you have to specify
a negative value for <literal>argc</literal>.
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r11937 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-6.0 | paul.dubois | 1 Oct |
