Author: paul
Date: 2007-11-03 17:12:18 +0100 (Sat, 03 Nov 2007)
New Revision: 8510
Log:
r26517@frost: paul | 2007-11-03 10:31:54 -0500
Add markup.
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:32208
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:26516
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:21581
+ 4767c598-dc10-0410-bea0-d01b485662eb:/mysqldoc-local/mysqldoc/trunk:32208
7d8d2c4e-af1d-0410-ab9f-b038ce55645b:/mysqldoc-local/mysqldoc:26517
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:21581
Modified: trunk/refman-4.1/apis-c.xml
===================================================================
--- trunk/refman-4.1/apis-c.xml 2007-11-03 16:12:08 UTC (rev 8509)
+++ trunk/refman-4.1/apis-c.xml 2007-11-03 16:12:18 UTC (rev 8510)
Changed blocks: 25, Lines Added: 57, Lines Deleted: 57; 15232 bytes
@@ -879,8 +879,8 @@
<row>
<entry><function role="capi">mysql_eof()</function></entry>
<entry>Determines whether the last row of a result set has been read (this
- function is deprecated; <literal>mysql_errno()</literal>
- or <literal>mysql_error()</literal> may be used instead)</entry>
+ function is deprecated; <function role="capi">mysql_errno()</function>
+ or <function role="capi">mysql_error()</function> may be used instead)</entry>
</row>
<row>
<entry><function role="capi">mysql_errno()</function></entry>
@@ -1389,8 +1389,8 @@
<para>
For detecting and reporting errors, MySQL provides access to error
- information by means of the <literal>mysql_errno()</literal> and
- <literal>mysql_error()</literal> functions. These return the error
+ information by means of the <function role="capi">mysql_errno()</function> and
+ <function role="capi">mysql_error()</function> functions. These return the error
code or error message for the most recently invoked function that
can succeed or fail, allowing you to determine when an error
occurred and what it was.
@@ -1436,8 +1436,8 @@
<emphasis role="bold">Errors</emphasis> subsection of the function
description lists the possible types of errors. You can find out
which of these occurred by calling
- <literal>mysql_errno()</literal>. A string representation of the
- error may be obtained by calling <literal>mysql_error()</literal>.
+ <function role="capi">mysql_errno()</function>. A string representation of the
+ error may be obtained by calling <function role="capi">mysql_error()</function>.
</para>
<formalpara role="mnmas-kb">
@@ -1947,8 +1947,8 @@
when you call <literal>mysql_close()</literal>. The disadvantage
of this approach is that you can't retrieve an error message if
the connection fails. (To get error information from
- <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal>, you must provide a valid
+ <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function>, you must provide a valid
<literal>MYSQL</literal> pointer.)
</para>
@@ -2384,12 +2384,12 @@
</remark>
<para>
- This function is deprecated. <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal> may be used instead.
+ This function is deprecated. <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function> may be used instead.
</para>
<para>
- <literal>mysql_eof()</literal> determines whether the last row
+ <function role="capi">mysql_eof()</function> determines whether the last row
of a result set has been read.
</para>
@@ -2400,9 +2400,9 @@
<literal>NULL</literal> return from
<literal>mysql_fetch_row()</literal> always means the end of the
result set has been reached and it is unnecessary to call
- <literal>mysql_eof()</literal>. When used with
+ <function role="capi">mysql_eof()</function>. When used with
<literal>mysql_store_result()</literal>,
- <literal>mysql_eof()</literal> always returns true.
+ <function role="capi">mysql_eof()</function> always returns true.
</para>
<para>
@@ -2414,20 +2414,20 @@
this process, a <literal>NULL</literal> return value from
<literal>mysql_fetch_row()</literal> does not necessarily mean
the end of the result set was reached normally. In this case,
- you can use <literal>mysql_eof()</literal> to determine what
- happened. <literal>mysql_eof()</literal> returns a non-zero
+ you can use <function role="capi">mysql_eof()</function> to determine what
+ happened. <function role="capi">mysql_eof()</function> returns a non-zero
value if the end of the result set was reached and zero if an
error occurred.
</para>
<para>
- Historically, <literal>mysql_eof()</literal> predates the
- standard MySQL error functions <literal>mysql_errno()</literal>
- and <literal>mysql_error()</literal>. Because those error
+ Historically, <function role="capi">mysql_eof()</function> predates the
+ standard MySQL error functions <function role="capi">mysql_errno()</function>
+ and <function role="capi">mysql_error()</function>. Because those error
functions provide the same information, their use is preferred
- over <literal>mysql_eof()</literal>, which is deprecated. (In
+ over <function role="capi">mysql_eof()</function>, which is deprecated. (In
fact, they provide more information, because
- <literal>mysql_eof()</literal> returns only a boolean value
+ <function role="capi">mysql_eof()</function> returns only a boolean value
whereas the error functions indicate a reason for the error when
one occurs.)
</para>
@@ -2455,7 +2455,7 @@
<para>
The following example shows how you might use
- <literal>mysql_eof()</literal>:
+ <function role="capi">mysql_eof()</function>:
</para>
<programlisting>
@@ -2509,7 +2509,7 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_errno()</literal> returns the error code for the
+ <function role="capi">mysql_errno()</function> returns the error code for the
most recently invoked API function that can succeed or fail. A
return value of zero means that no error occurred. Client error
message numbers are listed in the MySQL
@@ -2521,24 +2521,24 @@
<para>
Note that some functions like
<literal>mysql_fetch_row()</literal> don't set
- <literal>mysql_errno()</literal> if they succeed.
+ <function role="capi">mysql_errno()</function> if they succeed.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_errno()</literal> if
+ server for information reset <function role="capi">mysql_errno()</function> if
they succeed.
</para>
<para>
MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal> differ from SQLSTATE values
- returned by <literal>mysql_sqlstate()</literal>. For example,
+ <function role="capi">mysql_errno()</function> differ from SQLSTATE values
+ returned by <function role="capi">mysql_sqlstate()</function>. For example,
the <command>mysql</command> client program displays errors
using the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -2584,21 +2584,21 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_error()</literal> returns a null-terminated
+ <function role="capi">mysql_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked API function that failed. If a function didn't fail, the
- return value of <literal>mysql_error()</literal> may be the
+ return value of <function role="capi">mysql_error()</function> may be the
previous error or an empty string to indicate no error.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_error()</literal> if
+ server for information reset <function role="capi">mysql_error()</function> if
they succeed.
</para>
<para>
- For functions that reset <literal>mysql_error()</literal>, the
+ For functions that reset <function role="capi">mysql_error()</function>, the
following two tests are equivalent:
</para>
@@ -3166,7 +3166,7 @@
<para>
An alternative is to replace the
<literal>mysql_field_count(&mysql)</literal> call with
- <literal>mysql_errno(&mysql)</literal>. In this case, you
+ <function role="capi">mysql_errno(&mysql)</function>. In this case, you
are checking directly for an error from
<literal>mysql_store_result()</literal> rather than inferring
from the value of <literal>mysql_field_count()</literal> whether
@@ -4968,7 +4968,7 @@
<para>
An alternative (if you know that your query should have returned
a result set) is to replace the
- <literal>mysql_errno(&mysql)</literal> call with a check
+ <function role="capi">mysql_errno(&mysql)</function> call with a check
whether <literal>mysql_field_count(&mysql)</literal> returns
0. This happens only if something went wrong.
</para>
@@ -7444,14 +7444,14 @@
</para>
<para>
- SQLSTATE values returned by <literal>mysql_sqlstate()</literal>
+ SQLSTATE values returned by <function role="capi">mysql_sqlstate()</function>
differ from MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal>. For example, the
+ <function role="capi">mysql_errno()</function>. For example, the
<command>mysql</command> client program displays errors using
the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -7466,9 +7466,9 @@
</para>
<para>
- If you call <literal>mysql_sqlstate()</literal> after
+ If you call <function role="capi">mysql_sqlstate()</function> after
<function role="capi">mysql_real_connect()</function> fails,
- <literal>mysql_sqlstate()</literal> might not return a useful
+ <function role="capi">mysql_sqlstate()</function> might not return a useful
value. For example, this happens if a host is blocked by the
server and the connection is closed without any SQLSTATE value
being sent to the client.
@@ -7743,8 +7743,8 @@
<literal>mysql_store_result()</literal> also returns a null
pointer if reading of the result set failed. You can check
whether an error occurred by checking whether
- <literal>mysql_error()</literal> returns a non-empty string,
- <literal>mysql_errno()</literal> returns non-zero, or
+ <function role="capi">mysql_error()</function> returns a non-empty string,
+ <function role="capi">mysql_errno()</function> returns non-zero, or
<literal>mysql_field_count()</literal> returns zero.
</para>
@@ -7787,8 +7787,8 @@
<para>
<literal>mysql_store_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -7993,8 +7993,8 @@
<para>
<literal>mysql_use_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -9387,9 +9387,9 @@
<para>
If an error occurs, you can get the statement error code, error
message, and SQLSTATE value using
- <literal>mysql_stmt_errno()</literal>,
- <literal>mysql_stmt_error()</literal>, and
- <literal>mysql_stmt_sqlstate()</literal>, respectively.
+ <function role="capi">mysql_stmt_errno()</function>,
+ <function role="capi">mysql_stmt_error()</function>, and
+ <function role="capi">mysql_stmt_sqlstate()</function>, respectively.
</para>
<para>
@@ -10150,7 +10150,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_errno()</literal> returns the error code for
+ <function role="capi">mysql_stmt_errno()</function> returns the error code for
the most recently invoked statement API function that can
succeed or fail. A return value of zero means that no error
occurred. Client error message numbers are listed in the MySQL
@@ -10200,7 +10200,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_error()</literal> returns a null-terminated
+ <function role="capi">mysql_stmt_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked statement API function that can succeed or fail. An
empty string (<literal>""</literal>) is returned if no error
@@ -10706,8 +10706,8 @@
<row>
<entry>1</entry>
<entry>Error occurred. Error code and message can be obtained by calling
- <literal>mysql_stmt_errno()</literal> and
- <literal>mysql_stmt_error()</literal>.</entry>
+ <function role="capi">mysql_stmt_errno()</function> and
+ <function role="capi">mysql_stmt_error()</function>.</entry>
</row>
<row>
<entry><literal>MYSQL_NO_DATA</literal></entry>
@@ -11637,7 +11637,7 @@
If the prepare operation was unsuccessful (that is,
<literal>mysql_stmt_prepare()</literal> returns non-zero), the
error message can be obtained by calling
- <literal>mysql_stmt_error()</literal>.
+ <function role="capi">mysql_stmt_error()</function>.
</para>
<para>
@@ -12206,7 +12206,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_sqlstate()</literal> returns a
+ <function role="capi">mysql_stmt_sqlstate()</function> returns a
null-terminated string containing the SQLSTATE error code for
the most recently invoked prepared statement API function that
can succeed or fail. The error code consists of five characters.
@@ -13265,8 +13265,8 @@
<para>
You can test for an error by calling
- <literal>mysql_error()</literal> or
- <literal>mysql_errno()</literal>.
+ <function role="capi">mysql_error()</function> or
+ <function role="capi">mysql_errno()</function>.
</para>
</section>
Modified: trunk/refman-5.0/apis-c.xml
===================================================================
--- trunk/refman-5.0/apis-c.xml 2007-11-03 16:12:08 UTC (rev 8509)
+++ trunk/refman-5.0/apis-c.xml 2007-11-03 16:12:18 UTC (rev 8510)
Changed blocks: 25, Lines Added: 57, Lines Deleted: 57; 15232 bytes
@@ -898,8 +898,8 @@
<row>
<entry><function role="capi">mysql_eof()</function></entry>
<entry>Determines whether the last row of a result set has been read (this
- function is deprecated; <literal>mysql_errno()</literal>
- or <literal>mysql_error()</literal> may be used instead)</entry>
+ function is deprecated; <function role="capi">mysql_errno()</function>
+ or <function role="capi">mysql_error()</function> may be used instead)</entry>
</row>
<row>
<entry><function role="capi">mysql_errno()</function></entry>
@@ -1420,8 +1420,8 @@
<para>
For detecting and reporting errors, MySQL provides access to error
- information by means of the <literal>mysql_errno()</literal> and
- <literal>mysql_error()</literal> functions. These return the error
+ information by means of the <function role="capi">mysql_errno()</function> and
+ <function role="capi">mysql_error()</function> functions. These return the error
code or error message for the most recently invoked function that
can succeed or fail, allowing you to determine when an error
occurred and what it was.
@@ -1467,8 +1467,8 @@
<emphasis role="bold">Errors</emphasis> subsection of the function
description lists the possible types of errors. You can find out
which of these occurred by calling
- <literal>mysql_errno()</literal>. A string representation of the
- error may be obtained by calling <literal>mysql_error()</literal>.
+ <function role="capi">mysql_errno()</function>. A string representation of the
+ error may be obtained by calling <function role="capi">mysql_error()</function>.
</para>
<formalpara role="mnmas-kb">
@@ -1976,8 +1976,8 @@
when you call <literal>mysql_close()</literal>. The disadvantage
of this approach is that you can't retrieve an error message if
the connection fails. (To get error information from
- <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal>, you must provide a valid
+ <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function>, you must provide a valid
<literal>MYSQL</literal> pointer.)
</para>
@@ -2413,12 +2413,12 @@
</remark>
<para>
- This function is deprecated. <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal> may be used instead.
+ This function is deprecated. <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function> may be used instead.
</para>
<para>
- <literal>mysql_eof()</literal> determines whether the last row
+ <function role="capi">mysql_eof()</function> determines whether the last row
of a result set has been read.
</para>
@@ -2429,9 +2429,9 @@
<literal>NULL</literal> return from
<literal>mysql_fetch_row()</literal> always means the end of the
result set has been reached and it is unnecessary to call
- <literal>mysql_eof()</literal>. When used with
+ <function role="capi">mysql_eof()</function>. When used with
<literal>mysql_store_result()</literal>,
- <literal>mysql_eof()</literal> always returns true.
+ <function role="capi">mysql_eof()</function> always returns true.
</para>
<para>
@@ -2443,20 +2443,20 @@
this process, a <literal>NULL</literal> return value from
<literal>mysql_fetch_row()</literal> does not necessarily mean
the end of the result set was reached normally. In this case,
- you can use <literal>mysql_eof()</literal> to determine what
- happened. <literal>mysql_eof()</literal> returns a non-zero
+ you can use <function role="capi">mysql_eof()</function> to determine what
+ happened. <function role="capi">mysql_eof()</function> returns a non-zero
value if the end of the result set was reached and zero if an
error occurred.
</para>
<para>
- Historically, <literal>mysql_eof()</literal> predates the
- standard MySQL error functions <literal>mysql_errno()</literal>
- and <literal>mysql_error()</literal>. Because those error
+ Historically, <function role="capi">mysql_eof()</function> predates the
+ standard MySQL error functions <function role="capi">mysql_errno()</function>
+ and <function role="capi">mysql_error()</function>. Because those error
functions provide the same information, their use is preferred
- over <literal>mysql_eof()</literal>, which is deprecated. (In
+ over <function role="capi">mysql_eof()</function>, which is deprecated. (In
fact, they provide more information, because
- <literal>mysql_eof()</literal> returns only a boolean value
+ <function role="capi">mysql_eof()</function> returns only a boolean value
whereas the error functions indicate a reason for the error when
one occurs.)
</para>
@@ -2484,7 +2484,7 @@
<para>
The following example shows how you might use
- <literal>mysql_eof()</literal>:
+ <function role="capi">mysql_eof()</function>:
</para>
<programlisting>
@@ -2538,7 +2538,7 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_errno()</literal> returns the error code for the
+ <function role="capi">mysql_errno()</function> returns the error code for the
most recently invoked API function that can succeed or fail. A
return value of zero means that no error occurred. Client error
message numbers are listed in the MySQL
@@ -2550,24 +2550,24 @@
<para>
Note that some functions like
<literal>mysql_fetch_row()</literal> don't set
- <literal>mysql_errno()</literal> if they succeed.
+ <function role="capi">mysql_errno()</function> if they succeed.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_errno()</literal> if
+ server for information reset <function role="capi">mysql_errno()</function> if
they succeed.
</para>
<para>
MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal> differ from SQLSTATE values
- returned by <literal>mysql_sqlstate()</literal>. For example,
+ <function role="capi">mysql_errno()</function> differ from SQLSTATE values
+ returned by <function role="capi">mysql_sqlstate()</function>. For example,
the <command>mysql</command> client program displays errors
using the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -2613,21 +2613,21 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_error()</literal> returns a null-terminated
+ <function role="capi">mysql_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked API function that failed. If a function didn't fail, the
- return value of <literal>mysql_error()</literal> may be the
+ return value of <function role="capi">mysql_error()</function> may be the
previous error or an empty string to indicate no error.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_error()</literal> if
+ server for information reset <function role="capi">mysql_error()</function> if
they succeed.
</para>
<para>
- For functions that reset <literal>mysql_error()</literal>, the
+ For functions that reset <function role="capi">mysql_error()</function>, the
following two tests are equivalent:
</para>
@@ -3189,7 +3189,7 @@
<para>
An alternative is to replace the
<literal>mysql_field_count(&mysql)</literal> call with
- <literal>mysql_errno(&mysql)</literal>. In this case, you
+ <function role="capi">mysql_errno(&mysql)</function>. In this case, you
are checking directly for an error from
<literal>mysql_store_result()</literal> rather than inferring
from the value of <literal>mysql_field_count()</literal> whether
@@ -5057,7 +5057,7 @@
<para>
An alternative (if you know that your query should have returned
a result set) is to replace the
- <literal>mysql_errno(&mysql)</literal> call with a check
+ <function role="capi">mysql_errno(&mysql)</function> call with a check
whether <literal>mysql_field_count(&mysql)</literal> returns
0. This happens only if something went wrong.
</para>
@@ -7608,14 +7608,14 @@
</para>
<para>
- SQLSTATE values returned by <literal>mysql_sqlstate()</literal>
+ SQLSTATE values returned by <function role="capi">mysql_sqlstate()</function>
differ from MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal>. For example, the
+ <function role="capi">mysql_errno()</function>. For example, the
<command>mysql</command> client program displays errors using
the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -7630,9 +7630,9 @@
</para>
<para>
- If you call <literal>mysql_sqlstate()</literal> after
+ If you call <function role="capi">mysql_sqlstate()</function> after
<function role="capi">mysql_real_connect()</function> fails,
- <literal>mysql_sqlstate()</literal> might not return a useful
+ <function role="capi">mysql_sqlstate()</function> might not return a useful
value. For example, this happens if a host is blocked by the
server and the connection is closed without any SQLSTATE value
being sent to the client.
@@ -7903,8 +7903,8 @@
<literal>mysql_store_result()</literal> also returns a null
pointer if reading of the result set failed. You can check
whether an error occurred by checking whether
- <literal>mysql_error()</literal> returns a non-empty string,
- <literal>mysql_errno()</literal> returns non-zero, or
+ <function role="capi">mysql_error()</function> returns a non-empty string,
+ <function role="capi">mysql_errno()</function> returns non-zero, or
<literal>mysql_field_count()</literal> returns zero.
</para>
@@ -7947,8 +7947,8 @@
<para>
<literal>mysql_store_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -8153,8 +8153,8 @@
<para>
<literal>mysql_use_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -9562,9 +9562,9 @@
<para>
If an error occurs, you can get the statement error code, error
message, and SQLSTATE value using
- <literal>mysql_stmt_errno()</literal>,
- <literal>mysql_stmt_error()</literal>, and
- <literal>mysql_stmt_sqlstate()</literal>, respectively.
+ <function role="capi">mysql_stmt_errno()</function>,
+ <function role="capi">mysql_stmt_error()</function>, and
+ <function role="capi">mysql_stmt_sqlstate()</function>, respectively.
</para>
<para>
@@ -10327,7 +10327,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_errno()</literal> returns the error code for
+ <function role="capi">mysql_stmt_errno()</function> returns the error code for
the most recently invoked statement API function that can
succeed or fail. A return value of zero means that no error
occurred. Client error message numbers are listed in the MySQL
@@ -10373,7 +10373,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_error()</literal> returns a null-terminated
+ <function role="capi">mysql_stmt_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked statement API function that can succeed or fail. An
empty string (<literal>""</literal>) is returned if no error
@@ -10867,8 +10867,8 @@
<row>
<entry>1</entry>
<entry>Error occurred. Error code and message can be obtained by calling
- <literal>mysql_stmt_errno()</literal> and
- <literal>mysql_stmt_error()</literal>.</entry>
+ <function role="capi">mysql_stmt_errno()</function> and
+ <function role="capi">mysql_stmt_error()</function>.</entry>
</row>
<row>
<entry><literal>MYSQL_NO_DATA</literal></entry>
@@ -11768,7 +11768,7 @@
If the prepare operation was unsuccessful (that is,
<literal>mysql_stmt_prepare()</literal> returns non-zero), the
error message can be obtained by calling
- <literal>mysql_stmt_error()</literal>.
+ <function role="capi">mysql_stmt_error()</function>.
</para>
<para>
@@ -12327,7 +12327,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_sqlstate()</literal> returns a
+ <function role="capi">mysql_stmt_sqlstate()</function> returns a
null-terminated string containing the SQLSTATE error code for
the most recently invoked prepared statement API function that
can succeed or fail. The error code consists of five characters.
@@ -13429,8 +13429,8 @@
<para>
You can test for an error by calling
- <literal>mysql_error()</literal> or
- <literal>mysql_errno()</literal>.
+ <function role="capi">mysql_error()</function> or
+ <function role="capi">mysql_errno()</function>.
</para>
</section>
Modified: trunk/refman-5.1/apis-c.xml
===================================================================
--- trunk/refman-5.1/apis-c.xml 2007-11-03 16:12:08 UTC (rev 8509)
+++ trunk/refman-5.1/apis-c.xml 2007-11-03 16:12:18 UTC (rev 8510)
Changed blocks: 25, Lines Added: 57, Lines Deleted: 57; 15232 bytes
@@ -891,8 +891,8 @@
<row>
<entry><function role="capi">mysql_eof()</function></entry>
<entry>Determines whether the last row of a result set has been read (this
- function is deprecated; <literal>mysql_errno()</literal>
- or <literal>mysql_error()</literal> may be used instead)</entry>
+ function is deprecated; <function role="capi">mysql_errno()</function>
+ or <function role="capi">mysql_error()</function> may be used instead)</entry>
</row>
<row>
<entry><function role="capi">mysql_errno()</function></entry>
@@ -1405,8 +1405,8 @@
<para>
For detecting and reporting errors, MySQL provides access to error
- information by means of the <literal>mysql_errno()</literal> and
- <literal>mysql_error()</literal> functions. These return the error
+ information by means of the <function role="capi">mysql_errno()</function> and
+ <function role="capi">mysql_error()</function> functions. These return the error
code or error message for the most recently invoked function that
can succeed or fail, allowing you to determine when an error
occurred and what it was.
@@ -1452,8 +1452,8 @@
<emphasis role="bold">Errors</emphasis> subsection of the function
description lists the possible types of errors. You can find out
which of these occurred by calling
- <literal>mysql_errno()</literal>. A string representation of the
- error may be obtained by calling <literal>mysql_error()</literal>.
+ <function role="capi">mysql_errno()</function>. A string representation of the
+ error may be obtained by calling <function role="capi">mysql_error()</function>.
</para>
<formalpara role="mnmas-kb">
@@ -1960,8 +1960,8 @@
when you call <literal>mysql_close()</literal>. The disadvantage
of this approach is that you can't retrieve an error message if
the connection fails. (To get error information from
- <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal>, you must provide a valid
+ <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function>, you must provide a valid
<literal>MYSQL</literal> pointer.)
</para>
@@ -2397,12 +2397,12 @@
</remark>
<para>
- This function is deprecated. <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal> may be used instead.
+ This function is deprecated. <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function> may be used instead.
</para>
<para>
- <literal>mysql_eof()</literal> determines whether the last row
+ <function role="capi">mysql_eof()</function> determines whether the last row
of a result set has been read.
</para>
@@ -2413,9 +2413,9 @@
<literal>NULL</literal> return from
<literal>mysql_fetch_row()</literal> always means the end of the
result set has been reached and it is unnecessary to call
- <literal>mysql_eof()</literal>. When used with
+ <function role="capi">mysql_eof()</function>. When used with
<literal>mysql_store_result()</literal>,
- <literal>mysql_eof()</literal> always returns true.
+ <function role="capi">mysql_eof()</function> always returns true.
</para>
<para>
@@ -2427,20 +2427,20 @@
this process, a <literal>NULL</literal> return value from
<literal>mysql_fetch_row()</literal> does not necessarily mean
the end of the result set was reached normally. In this case,
- you can use <literal>mysql_eof()</literal> to determine what
- happened. <literal>mysql_eof()</literal> returns a non-zero
+ you can use <function role="capi">mysql_eof()</function> to determine what
+ happened. <function role="capi">mysql_eof()</function> returns a non-zero
value if the end of the result set was reached and zero if an
error occurred.
</para>
<para>
- Historically, <literal>mysql_eof()</literal> predates the
- standard MySQL error functions <literal>mysql_errno()</literal>
- and <literal>mysql_error()</literal>. Because those error
+ Historically, <function role="capi">mysql_eof()</function> predates the
+ standard MySQL error functions <function role="capi">mysql_errno()</function>
+ and <function role="capi">mysql_error()</function>. Because those error
functions provide the same information, their use is preferred
- over <literal>mysql_eof()</literal>, which is deprecated. (In
+ over <function role="capi">mysql_eof()</function>, which is deprecated. (In
fact, they provide more information, because
- <literal>mysql_eof()</literal> returns only a boolean value
+ <function role="capi">mysql_eof()</function> returns only a boolean value
whereas the error functions indicate a reason for the error when
one occurs.)
</para>
@@ -2468,7 +2468,7 @@
<para>
The following example shows how you might use
- <literal>mysql_eof()</literal>:
+ <function role="capi">mysql_eof()</function>:
</para>
<programlisting>
@@ -2522,7 +2522,7 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_errno()</literal> returns the error code for the
+ <function role="capi">mysql_errno()</function> returns the error code for the
most recently invoked API function that can succeed or fail. A
return value of zero means that no error occurred. Client error
message numbers are listed in the MySQL
@@ -2534,24 +2534,24 @@
<para>
Note that some functions like
<literal>mysql_fetch_row()</literal> don't set
- <literal>mysql_errno()</literal> if they succeed.
+ <function role="capi">mysql_errno()</function> if they succeed.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_errno()</literal> if
+ server for information reset <function role="capi">mysql_errno()</function> if
they succeed.
</para>
<para>
MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal> differ from SQLSTATE values
- returned by <literal>mysql_sqlstate()</literal>. For example,
+ <function role="capi">mysql_errno()</function> differ from SQLSTATE values
+ returned by <function role="capi">mysql_sqlstate()</function>. For example,
the <command>mysql</command> client program displays errors
using the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -2597,21 +2597,21 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_error()</literal> returns a null-terminated
+ <function role="capi">mysql_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked API function that failed. If a function didn't fail, the
- return value of <literal>mysql_error()</literal> may be the
+ return value of <function role="capi">mysql_error()</function> may be the
previous error or an empty string to indicate no error.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_error()</literal> if
+ server for information reset <function role="capi">mysql_error()</function> if
they succeed.
</para>
<para>
- For functions that reset <literal>mysql_error()</literal>, the
+ For functions that reset <function role="capi">mysql_error()</function>, the
following two tests are equivalent:
</para>
@@ -3173,7 +3173,7 @@
<para>
An alternative is to replace the
<literal>mysql_field_count(&mysql)</literal> call with
- <literal>mysql_errno(&mysql)</literal>. In this case, you
+ <function role="capi">mysql_errno(&mysql)</function>. In this case, you
are checking directly for an error from
<literal>mysql_store_result()</literal> rather than inferring
from the value of <literal>mysql_field_count()</literal> whether
@@ -5119,7 +5119,7 @@
<para>
An alternative (if you know that your query should have returned
a result set) is to replace the
- <literal>mysql_errno(&mysql)</literal> call with a check
+ <function role="capi">mysql_errno(&mysql)</function> call with a check
whether <literal>mysql_field_count(&mysql)</literal> returns
0. This happens only if something went wrong.
</para>
@@ -7668,14 +7668,14 @@
</para>
<para>
- SQLSTATE values returned by <literal>mysql_sqlstate()</literal>
+ SQLSTATE values returned by <function role="capi">mysql_sqlstate()</function>
differ from MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal>. For example, the
+ <function role="capi">mysql_errno()</function>. For example, the
<command>mysql</command> client program displays errors using
the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -7690,9 +7690,9 @@
</para>
<para>
- If you call <literal>mysql_sqlstate()</literal> after
+ If you call <function role="capi">mysql_sqlstate()</function> after
<function role="capi">mysql_real_connect()</function> fails,
- <literal>mysql_sqlstate()</literal> might not return a useful
+ <function role="capi">mysql_sqlstate()</function> might not return a useful
value. For example, this happens if a host is blocked by the
server and the connection is closed without any SQLSTATE value
being sent to the client.
@@ -7963,8 +7963,8 @@
<literal>mysql_store_result()</literal> also returns a null
pointer if reading of the result set failed. You can check
whether an error occurred by checking whether
- <literal>mysql_error()</literal> returns a non-empty string,
- <literal>mysql_errno()</literal> returns non-zero, or
+ <function role="capi">mysql_error()</function> returns a non-empty string,
+ <function role="capi">mysql_errno()</function> returns non-zero, or
<literal>mysql_field_count()</literal> returns zero.
</para>
@@ -8007,8 +8007,8 @@
<para>
<literal>mysql_store_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -8213,8 +8213,8 @@
<para>
<literal>mysql_use_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -9663,9 +9663,9 @@
<para>
If an error occurs, you can get the statement error code, error
message, and SQLSTATE value using
- <literal>mysql_stmt_errno()</literal>,
- <literal>mysql_stmt_error()</literal>, and
- <literal>mysql_stmt_sqlstate()</literal>, respectively.
+ <function role="capi">mysql_stmt_errno()</function>,
+ <function role="capi">mysql_stmt_error()</function>, and
+ <function role="capi">mysql_stmt_sqlstate()</function>, respectively.
</para>
<para>
@@ -10411,7 +10411,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_errno()</literal> returns the error code for
+ <function role="capi">mysql_stmt_errno()</function> returns the error code for
the most recently invoked statement API function that can
succeed or fail. A return value of zero means that no error
occurred. Client error message numbers are listed in the MySQL
@@ -10457,7 +10457,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_error()</literal> returns a null-terminated
+ <function role="capi">mysql_stmt_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked statement API function that can succeed or fail. An
empty string (<literal>""</literal>) is returned if no error
@@ -10951,8 +10951,8 @@
<row>
<entry>1</entry>
<entry>Error occurred. Error code and message can be obtained by calling
- <literal>mysql_stmt_errno()</literal> and
- <literal>mysql_stmt_error()</literal>.</entry>
+ <function role="capi">mysql_stmt_errno()</function> and
+ <function role="capi">mysql_stmt_error()</function>.</entry>
</row>
<row>
<entry><literal>MYSQL_NO_DATA</literal></entry>
@@ -11852,7 +11852,7 @@
If the prepare operation was unsuccessful (that is,
<literal>mysql_stmt_prepare()</literal> returns non-zero), the
error message can be obtained by calling
- <literal>mysql_stmt_error()</literal>.
+ <function role="capi">mysql_stmt_error()</function>.
</para>
<para>
@@ -12411,7 +12411,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_sqlstate()</literal> returns a
+ <function role="capi">mysql_stmt_sqlstate()</function> returns a
null-terminated string containing the SQLSTATE error code for
the most recently invoked prepared statement API function that
can succeed or fail. The error code consists of five characters.
@@ -13484,8 +13484,8 @@
<para>
You can test for an error by calling
- <literal>mysql_error()</literal> or
- <literal>mysql_errno()</literal>.
+ <function role="capi">mysql_error()</function> or
+ <function role="capi">mysql_errno()</function>.
</para>
</section>
Modified: trunk/refman-6.0/apis-c.xml
===================================================================
--- trunk/refman-6.0/apis-c.xml 2007-11-03 16:12:08 UTC (rev 8509)
+++ trunk/refman-6.0/apis-c.xml 2007-11-03 16:12:18 UTC (rev 8510)
Changed blocks: 25, Lines Added: 57, Lines Deleted: 57; 15238 bytes
@@ -875,8 +875,8 @@
<row>
<entry><function role="capi">mysql_eof()</function></entry>
<entry>Determines whether the last row of a result set has been read (this
- function is deprecated; <literal>mysql_errno()</literal>
- or <literal>mysql_error()</literal> may be used instead)</entry>
+ function is deprecated; <function role="capi">mysql_errno()</function>
+ or <function role="capi">mysql_error()</function> may be used instead)</entry>
</row>
<row>
<entry><function role="capi">mysql_errno()</function></entry>
@@ -1389,8 +1389,8 @@
<para>
For detecting and reporting errors, MySQL provides access to error
- information by means of the <literal>mysql_errno()</literal> and
- <literal>mysql_error()</literal> functions. These return the error
+ information by means of the <function role="capi">mysql_errno()</function> and
+ <function role="capi">mysql_error()</function> functions. These return the error
code or error message for the most recently invoked function that
can succeed or fail, allowing you to determine when an error
occurred and what it was.
@@ -1436,8 +1436,8 @@
<emphasis role="bold">Errors</emphasis> subsection of the function
description lists the possible types of errors. You can find out
which of these occurred by calling
- <literal>mysql_errno()</literal>. A string representation of the
- error may be obtained by calling <literal>mysql_error()</literal>.
+ <function role="capi">mysql_errno()</function>. A string representation of the
+ error may be obtained by calling <function role="capi">mysql_error()</function>.
</para>
<section id="mysql-affected-rows">
@@ -1928,8 +1928,8 @@
when you call <literal>mysql_close()</literal>. The disadvantage
of this approach is that you can't retrieve an error message if
the connection fails. (To get error information from
- <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal>, you must provide a valid
+ <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function>, you must provide a valid
<literal>MYSQL</literal> pointer.)
</para>
@@ -2365,12 +2365,12 @@
</remark>
<para>
- This function is deprecated. <literal>mysql_errno()</literal> or
- <literal>mysql_error()</literal> may be used instead.
+ This function is deprecated. <function role="capi">mysql_errno()</function> or
+ <function role="capi">mysql_error()</function> may be used instead.
</para>
<para>
- <literal>mysql_eof()</literal> determines whether the last row
+ <function role="capi">mysql_eof()</function> determines whether the last row
of a result set has been read.
</para>
@@ -2381,9 +2381,9 @@
<literal>NULL</literal> return from
<literal>mysql_fetch_row()</literal> always means the end of the
result set has been reached and it is unnecessary to call
- <literal>mysql_eof()</literal>. When used with
+ <function role="capi">mysql_eof()</function>. When used with
<literal>mysql_store_result()</literal>,
- <literal>mysql_eof()</literal> always returns true.
+ <function role="capi">mysql_eof()</function> always returns true.
</para>
<para>
@@ -2395,20 +2395,20 @@
this process, a <literal>NULL</literal> return value from
<literal>mysql_fetch_row()</literal> does not necessarily mean
the end of the result set was reached normally. In this case,
- you can use <literal>mysql_eof()</literal> to determine what
- happened. <literal>mysql_eof()</literal> returns a non-zero
+ you can use <function role="capi">mysql_eof()</function> to determine what
+ happened. <function role="capi">mysql_eof()</function> returns a non-zero
value if the end of the result set was reached and zero if an
error occurred.
</para>
<para>
- Historically, <literal>mysql_eof()</literal> predates the
- standard MySQL error functions <literal>mysql_errno()</literal>
- and <literal>mysql_error()</literal>. Because those error
+ Historically, <function role="capi">mysql_eof()</function> predates the
+ standard MySQL error functions <function role="capi">mysql_errno()</function>
+ and <function role="capi">mysql_error()</function>. Because those error
functions provide the same information, their use is preferred
- over <literal>mysql_eof()</literal>, which is deprecated. (In
+ over <function role="capi">mysql_eof()</function>, which is deprecated. (In
fact, they provide more information, because
- <literal>mysql_eof()</literal> returns only a boolean value
+ <function role="capi">mysql_eof()</function> returns only a boolean value
whereas the error functions indicate a reason for the error when
one occurs.)
</para>
@@ -2436,7 +2436,7 @@
<para>
The following example shows how you might use
- <literal>mysql_eof()</literal>:
+ <function role="capi">mysql_eof()</function>:
</para>
<programlisting>
@@ -2490,7 +2490,7 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_errno()</literal> returns the error code for the
+ <function role="capi">mysql_errno()</function> returns the error code for the
most recently invoked API function that can succeed or fail. A
return value of zero means that no error occurred. Client error
message numbers are listed in the MySQL
@@ -2502,24 +2502,24 @@
<para>
Note that some functions like
<literal>mysql_fetch_row()</literal> don't set
- <literal>mysql_errno()</literal> if they succeed.
+ <function role="capi">mysql_errno()</function> if they succeed.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_errno()</literal> if
+ server for information reset <function role="capi">mysql_errno()</function> if
they succeed.
</para>
<para>
MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal> differ from SQLSTATE values
- returned by <literal>mysql_sqlstate()</literal>. For example,
+ <function role="capi">mysql_errno()</function> differ from SQLSTATE values
+ returned by <function role="capi">mysql_sqlstate()</function>. For example,
the <command>mysql</command> client program displays errors
using the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -2565,21 +2565,21 @@
<para>
For the connection specified by <literal>mysql</literal>,
- <literal>mysql_error()</literal> returns a null-terminated
+ <function role="capi">mysql_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked API function that failed. If a function didn't fail, the
- return value of <literal>mysql_error()</literal> may be the
+ return value of <function role="capi">mysql_error()</function> may be the
previous error or an empty string to indicate no error.
</para>
<para>
A rule of thumb is that all functions that have to ask the
- server for information reset <literal>mysql_error()</literal> if
+ server for information reset <function role="capi">mysql_error()</function> if
they succeed.
</para>
<para>
- For functions that reset <literal>mysql_error()</literal>, the
+ For functions that reset <function role="capi">mysql_error()</function>, the
following two tests are equivalent:
</para>
@@ -3141,7 +3141,7 @@
<para>
An alternative is to replace the
<literal>mysql_field_count(&mysql)</literal> call with
- <literal>mysql_errno(&mysql)</literal>. In this case, you
+ <function role="capi">mysql_errno(&mysql)</function>. In this case, you
are checking directly for an error from
<literal>mysql_store_result()</literal> rather than inferring
from the value of <literal>mysql_field_count()</literal> whether
@@ -5075,7 +5075,7 @@
<para>
An alternative (if you know that your query should have returned
a result set) is to replace the
- <literal>mysql_errno(&mysql)</literal> call with a check
+ <function role="capi">mysql_errno(&mysql)</function> call with a check
whether <literal>mysql_field_count(&mysql)</literal> returns
0. This happens only if something went wrong.
</para>
@@ -7611,14 +7611,14 @@
</para>
<para>
- SQLSTATE values returned by <literal>mysql_sqlstate()</literal>
+ SQLSTATE values returned by <function role="capi">mysql_sqlstate()</function>
differ from MySQL-specific error numbers returned by
- <literal>mysql_errno()</literal>. For example, the
+ <function role="capi">mysql_errno()</function>. For example, the
<command>mysql</command> client program displays errors using
the following format, where <literal>1146</literal> is the
- <literal>mysql_errno()</literal> value and
+ <function role="capi">mysql_errno()</function> value and
<literal>'42S02'</literal> is the corresponding
- <literal>mysql_sqlstate()</literal> value:
+ <function role="capi">mysql_sqlstate()</function> value:
</para>
<programlisting>
@@ -7633,9 +7633,9 @@
</para>
<para>
- If you call <literal>mysql_sqlstate()</literal> after
+ If you call <function role="capi">mysql_sqlstate()</function> after
<function role="capi">mysql_real_connect()</function> fails,
- <literal>mysql_sqlstate()</literal> might not return a useful
+ <function role="capi">mysql_sqlstate()</function> might not return a useful
value. For example, this happens if a host is blocked by the
server and the connection is closed without any SQLSTATE value
being sent to the client.
@@ -7906,8 +7906,8 @@
<literal>mysql_store_result()</literal> also returns a null
pointer if reading of the result set failed. You can check
whether an error occurred by checking whether
- <literal>mysql_error()</literal> returns a non-empty string,
- <literal>mysql_errno()</literal> returns non-zero, or
+ <function role="capi">mysql_error()</function> returns a non-empty string,
+ <function role="capi">mysql_errno()</function> returns non-zero, or
<literal>mysql_field_count()</literal> returns zero.
</para>
@@ -7950,8 +7950,8 @@
<para>
<literal>mysql_store_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -8156,8 +8156,8 @@
<para>
<literal>mysql_use_result()</literal> resets
- <literal>mysql_error()</literal> and
- <literal>mysql_errno()</literal> if it succeeds.
+ <function role="capi">mysql_error()</function> and
+ <function role="capi">mysql_errno()</function> if it succeeds.
</para>
<itemizedlist>
@@ -9579,9 +9579,9 @@
<para>
If an error occurs, you can get the statement error code, error
message, and SQLSTATE value using
- <literal>mysql_stmt_errno()</literal>,
- <literal>mysql_stmt_error()</literal>, and
- <literal>mysql_stmt_sqlstate()</literal>, respectively.
+ <function role="capi">mysql_stmt_errno()</function>,
+ <function role="capi">mysql_stmt_error()</function>, and
+ <function role="capi">mysql_stmt_sqlstate()</function>, respectively.
</para>
<para>
@@ -10326,7 +10326,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_errno()</literal> returns the error code for
+ <function role="capi">mysql_stmt_errno()</function> returns the error code for
the most recently invoked statement API function that can
succeed or fail. A return value of zero means that no error
occurred. Client error message numbers are listed in the MySQL
@@ -10372,7 +10372,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_error()</literal> returns a null-terminated
+ <function role="capi">mysql_stmt_error()</function> returns a null-terminated
string containing the error message for the most recently
invoked statement API function that can succeed or fail. An
empty string (<literal>""</literal>) is returned if no error
@@ -10866,8 +10866,8 @@
<row>
<entry>1</entry>
<entry>Error occurred. Error code and message can be obtained by calling
- <literal>mysql_stmt_errno()</literal> and
- <literal>mysql_stmt_error()</literal>.</entry>
+ <function role="capi">mysql_stmt_errno()</function> and
+ <function role="capi">mysql_stmt_error()</function>.</entry>
</row>
<row>
<entry><literal>MYSQL_NO_DATA</literal></entry>
@@ -11767,7 +11767,7 @@
If the prepare operation was unsuccessful (that is,
<literal>mysql_stmt_prepare()</literal> returns non-zero), the
error message can be obtained by calling
- <literal>mysql_stmt_error()</literal>.
+ <function role="capi">mysql_stmt_error()</function>.
</para>
<para>
@@ -12326,7 +12326,7 @@
<para>
For the statement specified by <literal>stmt</literal>,
- <literal>mysql_stmt_sqlstate()</literal> returns a
+ <function role="capi">mysql_stmt_sqlstate()</function> returns a
null-terminated string containing the SQLSTATE error code for
the most recently invoked prepared statement API function that
can succeed or fail. The error code consists of five characters.
@@ -13383,8 +13383,8 @@
<para>
You can test for an error by calling
- <literal>mysql_error()</literal> or
- <literal>mysql_errno()</literal>.
+ <function role="capi">mysql_error()</function> or
+ <function role="capi">mysql_errno()</function>.
</para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8510 - in trunk: . refman-4.1 refman-5.0 refman-5.1 refman-6.0 | paul | 3 Nov |
