Author: paul
Date: 2007-11-03 17:12:27 +0100 (Sat, 03 Nov 2007)
New Revision: 8511
Log:
r26518@frost: paul | 2007-11-03 10:38:20 -0500
Add markup.
Modified:
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:26517
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:26518
b5ec3a16-e900-0410-9ad2-d183a3acac99:/mysqldoc-local/mysqldoc/trunk:14218
bf112a9c-6c03-0410-a055-ad865cd57414:/mysqldoc-local/mysqldoc/trunk:21581
Modified: trunk/refman-5.0/apis-c.xml
===================================================================
--- trunk/refman-5.0/apis-c.xml 2007-11-03 16:12:18 UTC (rev 8510)
+++ trunk/refman-5.0/apis-c.xml 2007-11-03 16:12:27 UTC (rev 8511)
Changed blocks: 35, Lines Added: 54, Lines Deleted: 54; 18139 bytes
@@ -944,7 +944,7 @@
<row>
<entry><function role="capi">mysql_field_tell()</function></entry>
<entry>Returns the position of the field cursor used for the last
- <literal>mysql_fetch_field()</literal></entry>
+ <function role="capi">mysql_fetch_field()</function></entry>
</row>
<row>
<entry><function role="capi">mysql_free_result()</function></entry>
@@ -1086,7 +1086,7 @@
<row>
<entry><function role="capi">mysql_row_seek()</function></entry>
<entry>Seeks to a row offset in a result set, using value returned from
- <literal>mysql_row_tell()</literal></entry>
+ <function role="capi">mysql_row_tell()</function></entry>
</row>
<row>
<entry><function role="capi">mysql_row_tell()</function></entry>
@@ -1211,7 +1211,7 @@
<listitem>
<para>
Close the connection to the MySQL server by calling
- <literal>mysql_close()</literal>.
+ <function role="capi">mysql_close()</function>.
</para>
</listitem>
@@ -1281,7 +1281,7 @@
you can use the <literal>MYSQL_OPT_RECONNECT</literal> option to
<function role="capi">mysql_options()</function> to control
reconnection behavior. When you are done with the connection, call
- <literal>mysql_close()</literal> to terminate it.
+ <function role="capi">mysql_close()</function> to terminate it.
</para>
<para>
@@ -1325,15 +1325,15 @@
<para>
In both cases, you access rows by calling
- <literal>mysql_fetch_row()</literal>. With
+ <function role="capi">mysql_fetch_row()</function>. With
<literal>mysql_store_result()</literal>,
- <literal>mysql_fetch_row()</literal> accesses rows that have
+ <function role="capi">mysql_fetch_row()</function> accesses rows that have
previously been fetched from the server. With
<literal>mysql_use_result()</literal>,
- <literal>mysql_fetch_row()</literal> actually retrieves the row
+ <function role="capi">mysql_fetch_row()</function> actually retrieves the row
from the server. Information about the size of the data in each
row is available by calling
- <literal>mysql_fetch_lengths()</literal>.
+ <function role="capi">mysql_fetch_lengths()</function>.
</para>
<para>
@@ -1354,7 +1354,7 @@
because the rows have all been fetched to the client, you not only
can access rows sequentially, you can move back and forth in the
result set using <literal>mysql_data_seek()</literal> or
- <literal>mysql_row_seek()</literal> to change the current row
+ <function role="capi">mysql_row_seek()</function> to change the current row
position within the result set. You can also find out how many
rows there are by calling <literal>mysql_num_rows()</literal>. On
the other hand, the memory requirements for
@@ -1407,15 +1407,15 @@
information about the fields that make up the result set (the
number of fields, their names and types, and so forth). You can
access field information sequentially within the row by calling
- <literal>mysql_fetch_field()</literal> repeatedly, or by field
+ <function role="capi">mysql_fetch_field()</function> repeatedly, or by field
number within the row by calling
- <literal>mysql_fetch_field_direct()</literal>. The current field
+ <function role="capi">mysql_fetch_field_direct()</function>. The current field
cursor position may be changed by calling
<literal>mysql_field_seek()</literal>. Setting the field cursor
affects subsequent calls to
- <literal>mysql_fetch_field()</literal>. You can also get
+ <function role="capi">mysql_fetch_field()</function>. You can also get
information for fields all at once by calling
- <literal>mysql_fetch_fields()</literal>.
+ <function role="capi">mysql_fetch_fields()</function>.
</para>
<para>
@@ -1856,7 +1856,7 @@
<para>
Closes a previously opened connection.
- <literal>mysql_close()</literal> also deallocates the connection
+ <function role="capi">mysql_close()</function> also deallocates the connection
handle pointed to by <literal>mysql</literal> if the handle was
allocated automatically by
<function role="capi">mysql_init()</function> or
@@ -1908,7 +1908,7 @@
<literal>completion_type</literal> is 2, the server performs a
release after terminating a transaction and closes the client
connection. The client program should call
- <literal>mysql_close()</literal> to close the connection from
+ <function role="capi">mysql_close()</function> to close the connection from
the client side.
</para>
@@ -1973,7 +1973,7 @@
difference that the connection parameter may be
<literal>NULL</literal>. In this case, the C API allocates
memory for the connection structure automatically and frees it
- when you call <literal>mysql_close()</literal>. The disadvantage
+ when you call <function role="capi">mysql_close()</function>. The disadvantage
of this approach is that you can't retrieve an error message if
the connection fails. (To get error information from
<function role="capi">mysql_errno()</function> or
@@ -2427,7 +2427,7 @@
<literal>mysql_store_result()</literal>, the client receives the
entire set in one operation. In this case, a
<literal>NULL</literal> return from
- <literal>mysql_fetch_row()</literal> always means the end of the
+ <function role="capi">mysql_fetch_row()</function> always means the end of the
result set has been reached and it is unnecessary to call
<function role="capi">mysql_eof()</function>. When used with
<literal>mysql_store_result()</literal>,
@@ -2438,10 +2438,10 @@
On the other hand, if you use
<literal>mysql_use_result()</literal> to initiate a result set
retrieval, the rows of the set are obtained from the server one
- by one as you call <literal>mysql_fetch_row()</literal>
+ by one as you call <function role="capi">mysql_fetch_row()</function>
repeatedly. Because an error may occur on the connection during
this process, a <literal>NULL</literal> return value from
- <literal>mysql_fetch_row()</literal> does not necessarily mean
+ <function role="capi">mysql_fetch_row()</function> does not necessarily mean
the end of the result set was reached normally. In this case,
you can use <function role="capi">mysql_eof()</function> to determine what
happened. <function role="capi">mysql_eof()</function> returns a non-zero
@@ -2549,7 +2549,7 @@
<para>
Note that some functions like
- <literal>mysql_fetch_row()</literal> don't set
+ <function role="capi">mysql_fetch_row()</function> don't set
<function role="capi">mysql_errno()</function> if they succeed.
</para>
@@ -2716,15 +2716,15 @@
Returns the definition of one column of a result set as a
<literal>MYSQL_FIELD</literal> structure. Call this function
repeatedly to retrieve information about all columns in the
- result set. <literal>mysql_fetch_field()</literal> returns
+ result set. <function role="capi">mysql_fetch_field()</function> returns
<literal>NULL</literal> when no more fields are left.
</para>
<para>
- <literal>mysql_fetch_field()</literal> is reset to return
+ <function role="capi">mysql_fetch_field()</function> is reset to return
information about the first field each time you execute a new
<literal>SELECT</literal> query. The field returned by
- <literal>mysql_fetch_field()</literal> is also affected by calls
+ <function role="capi">mysql_fetch_field()</function> is also affected by calls
to <literal>mysql_field_seek()</literal>.
</para>
@@ -2733,7 +2733,7 @@
<literal>SELECT</literal> on a table but have not called
<literal>mysql_store_result()</literal>, MySQL returns the
default blob length (8KB) if you call
- <literal>mysql_fetch_field()</literal> to ask for the length of
+ <function role="capi">mysql_fetch_field()</function> to ask for the length of
a <literal>BLOB</literal> field. (The 8KB size is chosen because
MySQL doesn't know the maximum length for the
<literal>BLOB</literal>. This should be made configurable
@@ -2928,7 +2928,7 @@
The length for empty columns and for columns containing
<literal>NULL</literal> values is zero. To see how to
distinguish these two cases, see the description for
- <literal>mysql_fetch_row()</literal>.
+ <function role="capi">mysql_fetch_row()</function>.
</para>
<para>
@@ -2946,10 +2946,10 @@
</para>
<para>
- <literal>mysql_fetch_lengths()</literal> is valid only for the
+ <function role="capi">mysql_fetch_lengths()</function> is valid only for the
current row of the result set. It returns
<literal>NULL</literal> if you call it before calling
- <literal>mysql_fetch_row()</literal> or after retrieving all
+ <function role="capi">mysql_fetch_row()</function> or after retrieving all
rows in the result.
</para>
@@ -2997,10 +2997,10 @@
<para>
Retrieves the next row of a result set. When used after
<literal>mysql_store_result()</literal>,
- <literal>mysql_fetch_row()</literal> returns
+ <function role="capi">mysql_fetch_row()</function> returns
<literal>NULL</literal> when there are no more rows to retrieve.
When used after <literal>mysql_use_result()</literal>,
- <literal>mysql_fetch_row()</literal> returns
+ <function role="capi">mysql_fetch_row()</function> returns
<literal>NULL</literal> when there are no more rows to retrieve
or if an error occurred.
</para>
@@ -3009,7 +3009,7 @@
The number of values in the row is given by
<literal>mysql_num_fields(result)</literal>. If
<literal>row</literal> holds the return value from a call to
- <literal>mysql_fetch_row()</literal>, pointers to the values are
+ <function role="capi">mysql_fetch_row()</function>, pointers to the values are
accessed as <literal>row[0]</literal> to
<literal>row[mysql_num_fields(result)-1]</literal>.
<literal>NULL</literal> values in the row are indicated by
@@ -3018,7 +3018,7 @@
<para>
The lengths of the field values in the row may be obtained by
- calling <literal>mysql_fetch_lengths()</literal>. Empty fields
+ calling <function role="capi">mysql_fetch_lengths()</function>. Empty fields
and fields containing <literal>NULL</literal> both have length
0; you can distinguish these by checking the pointer for the
field value. If the pointer is <literal>NULL</literal>, the
@@ -3041,7 +3041,7 @@
<para>
Note that error is not reset between calls to
- <literal>mysql_fetch_row()</literal>
+ <function role="capi">mysql_fetch_row()</function>
</para>
<itemizedlist>
@@ -3217,7 +3217,7 @@
<para>
Sets the field cursor to the given offset. The next call to
- <literal>mysql_fetch_field()</literal> retrieves the field
+ <function role="capi">mysql_fetch_field()</function> retrieves the field
definition of the column associated with that offset.
</para>
@@ -3263,7 +3263,7 @@
<para>
Returns the position of the field cursor used for the last
- <literal>mysql_fetch_field()</literal>. This value can be used
+ <function role="capi">mysql_fetch_field()</function>. This value can be used
as an argument to <literal>mysql_field_seek()</literal>.
</para>
@@ -3914,7 +3914,7 @@
Otherwise, the object is initialized and the address of the
object is returned. If
<function role="capi">mysql_init()</function> allocates a new
- object, it is freed when <literal>mysql_close()</literal> is
+ object, it is freed when <function role="capi">mysql_close()</function> is
called to close the connection.
</para>
@@ -6886,7 +6886,7 @@
<literal>completion_type</literal> is 2, the server performs a
release after terminating a transaction and closes the client
connection. The client program should call
- <literal>mysql_close()</literal> to close the connection from
+ <function role="capi">mysql_close()</function> to close the connection from
the client side.
</para>
@@ -6928,8 +6928,8 @@
<para>
Sets the row cursor to an arbitrary row in a query result set.
The <literal>offset</literal> value is a row offset that should
- be a value returned from <literal>mysql_row_tell()</literal> or
- from <literal>mysql_row_seek()</literal>. This value is not a
+ be a value returned from <function role="capi">mysql_row_tell()</function> or
+ from <function role="capi">mysql_row_seek()</function>. This value is not a
row number; if you want to seek to a row within a result set by
number, use <literal>mysql_data_seek()</literal> instead.
</para>
@@ -6937,7 +6937,7 @@
<para>
This function requires that the result set structure contains
the entire result of the query, so
- <literal>mysql_row_seek()</literal> may be used only in
+ <function role="capi">mysql_row_seek()</function> may be used only in
conjunction with <literal>mysql_store_result()</literal>, not
with <literal>mysql_use_result()</literal>.
</para>
@@ -6948,7 +6948,7 @@
<para>
The previous value of the row cursor. This value may be passed
- to a subsequent call to <literal>mysql_row_seek()</literal>.
+ to a subsequent call to <function role="capi">mysql_row_seek()</function>.
</para>
<para>
@@ -6980,12 +6980,12 @@
<para>
Returns the current position of the row cursor for the last
- <literal>mysql_fetch_row()</literal>. This value can be used as
- an argument to <literal>mysql_row_seek()</literal>.
+ <function role="capi">mysql_fetch_row()</function>. This value can be used as
+ an argument to <function role="capi">mysql_row_seek()</function>.
</para>
<para>
- You should use <literal>mysql_row_tell()</literal> only after
+ You should use <function role="capi">mysql_row_tell()</function> only after
<literal>mysql_store_result()</literal>, not after
<literal>mysql_use_result()</literal>.
</para>
@@ -7922,9 +7922,9 @@
</para>
<para>
- You can call <literal>mysql_fetch_row()</literal> to fetch rows
- from the result set, or <literal>mysql_row_seek()</literal> and
- <literal>mysql_row_tell()</literal> to obtain or set the current
+ You can call <function role="capi">mysql_fetch_row()</function> to fetch rows
+ from the result set, or <function role="capi">mysql_row_seek()</function> and
+ <function role="capi">mysql_row_tell()</function> to obtain or set the current
row position within the result set.
</para>
@@ -8083,7 +8083,7 @@
retrieval but does not actually read the result set into the
client like <literal>mysql_store_result()</literal> does.
Instead, each row must be retrieved individually by making calls
- to <literal>mysql_fetch_row()</literal>. This reads the result
+ to <function role="capi">mysql_fetch_row()</function>. This reads the result
of a query directly from the server without storing it in a
temporary table or local buffer, which is somewhat faster and
uses much less memory than
@@ -8104,7 +8104,7 @@
<para>
When using <literal>mysql_use_result()</literal>, you must
- execute <literal>mysql_fetch_row()</literal> until a
+ execute <function role="capi">mysql_fetch_row()</function> until a
<literal>NULL</literal> value is returned, otherwise, the
unfetched rows are returned as part of the result set for your
next query. The C API gives the error <literal>Commands out of
@@ -8114,8 +8114,8 @@
<para>
You may not use <literal>mysql_data_seek()</literal>,
- <literal>mysql_row_seek()</literal>,
- <literal>mysql_row_tell()</literal>,
+ <function role="capi">mysql_row_seek()</function>,
+ <function role="capi">mysql_row_tell()</function>,
<literal>mysql_num_rows()</literal>, or
<function role="capi">mysql_affected_rows()</function> with a
result returned from <literal>mysql_use_result()</literal>, nor
@@ -11908,19 +11908,19 @@
<listitem>
<para>
- <literal>mysql_fetch_field()</literal>
+ <function role="capi">mysql_fetch_field()</function>
</para>
</listitem>
<listitem>
<para>
- <literal>mysql_fetch_field_direct()</literal>
+ <function role="capi">mysql_fetch_field_direct()</function>
</para>
</listitem>
<listitem>
<para>
- <literal>mysql_fetch_fields()</literal>
+ <function role="capi">mysql_fetch_fields()</function>
</para>
</listitem>
@@ -13469,7 +13469,7 @@
<literal>mysql_use_result()</literal>,
<literal>mysql_num_rows()</literal> may be called only after
you have fetched all the rows with
- <literal>mysql_fetch_row()</literal>.
+ <function role="capi">mysql_fetch_row()</function>.
</para>
</listitem>
Modified: trunk/refman-5.1/apis-c.xml
===================================================================
--- trunk/refman-5.1/apis-c.xml 2007-11-03 16:12:18 UTC (rev 8510)
+++ trunk/refman-5.1/apis-c.xml 2007-11-03 16:12:27 UTC (rev 8511)
Changed blocks: 35, Lines Added: 54, Lines Deleted: 54; 18171 bytes
@@ -937,7 +937,7 @@
<row>
<entry><function role="capi">mysql_field_tell()</function></entry>
<entry>Returns the position of the field cursor used for the last
- <literal>mysql_fetch_field()</literal></entry>
+ <function role="capi">mysql_fetch_field()</function></entry>
</row>
<row>
<entry><function role="capi">mysql_free_result()</function></entry>
@@ -1079,7 +1079,7 @@
<row>
<entry><function role="capi">mysql_row_seek()</function></entry>
<entry>Seeks to a row offset in a result set, using value returned from
- <literal>mysql_row_tell()</literal></entry>
+ <function role="capi">mysql_row_tell()</function></entry>
</row>
<row>
<entry><function role="capi">mysql_row_tell()</function></entry>
@@ -1204,7 +1204,7 @@
<listitem>
<para>
Close the connection to the MySQL server by calling
- <literal>mysql_close()</literal>.
+ <function role="capi">mysql_close()</function>.
</para>
</listitem>
@@ -1266,7 +1266,7 @@
<literal>MYSQL_OPT_RECONNECT</literal> option to
<function role="capi">mysql_options()</function> to control
reconnection behavior. When you are done with the connection, call
- <literal>mysql_close()</literal> to terminate it.
+ <function role="capi">mysql_close()</function> to terminate it.
</para>
<para>
@@ -1310,15 +1310,15 @@
<para>
In both cases, you access rows by calling
- <literal>mysql_fetch_row()</literal>. With
+ <function role="capi">mysql_fetch_row()</function>. With
<literal>mysql_store_result()</literal>,
- <literal>mysql_fetch_row()</literal> accesses rows that have
+ <function role="capi">mysql_fetch_row()</function> accesses rows that have
previously been fetched from the server. With
<literal>mysql_use_result()</literal>,
- <literal>mysql_fetch_row()</literal> actually retrieves the row
+ <function role="capi">mysql_fetch_row()</function> actually retrieves the row
from the server. Information about the size of the data in each
row is available by calling
- <literal>mysql_fetch_lengths()</literal>.
+ <function role="capi">mysql_fetch_lengths()</function>.
</para>
<para>
@@ -1339,7 +1339,7 @@
because the rows have all been fetched to the client, you not only
can access rows sequentially, you can move back and forth in the
result set using <literal>mysql_data_seek()</literal> or
- <literal>mysql_row_seek()</literal> to change the current row
+ <function role="capi">mysql_row_seek()</function> to change the current row
position within the result set. You can also find out how many
rows there are by calling <literal>mysql_num_rows()</literal>. On
the other hand, the memory requirements for
@@ -1392,15 +1392,15 @@
information about the fields that make up the result set (the
number of fields, their names and types, and so forth). You can
access field information sequentially within the row by calling
- <literal>mysql_fetch_field()</literal> repeatedly, or by field
+ <function role="capi">mysql_fetch_field()</function> repeatedly, or by field
number within the row by calling
- <literal>mysql_fetch_field_direct()</literal>. The current field
+ <function role="capi">mysql_fetch_field_direct()</function>. The current field
cursor position may be changed by calling
<literal>mysql_field_seek()</literal>. Setting the field cursor
affects subsequent calls to
- <literal>mysql_fetch_field()</literal>. You can also get
+ <function role="capi">mysql_fetch_field()</function>. You can also get
information for fields all at once by calling
- <literal>mysql_fetch_fields()</literal>.
+ <function role="capi">mysql_fetch_fields()</function>.
</para>
<para>
@@ -1841,7 +1841,7 @@
<para>
Closes a previously opened connection.
- <literal>mysql_close()</literal> also deallocates the connection
+ <function role="capi">mysql_close()</function> also deallocates the connection
handle pointed to by <literal>mysql</literal> if the handle was
allocated automatically by
<function role="capi">mysql_init()</function> or
@@ -1892,7 +1892,7 @@
particular, if the value of <literal>completion_type</literal>
is 2, the server performs a release after terminating a
transaction and closes the client connection. The client program
- should call <literal>mysql_close()</literal> to close the
+ should call <function role="capi">mysql_close()</function> to close the
connection from the client side.
</para>
@@ -1957,7 +1957,7 @@
difference that the connection parameter may be
<literal>NULL</literal>. In this case, the C API allocates
memory for the connection structure automatically and frees it
- when you call <literal>mysql_close()</literal>. The disadvantage
+ when you call <function role="capi">mysql_close()</function>. The disadvantage
of this approach is that you can't retrieve an error message if
the connection fails. (To get error information from
<function role="capi">mysql_errno()</function> or
@@ -2411,7 +2411,7 @@
<literal>mysql_store_result()</literal>, the client receives the
entire set in one operation. In this case, a
<literal>NULL</literal> return from
- <literal>mysql_fetch_row()</literal> always means the end of the
+ <function role="capi">mysql_fetch_row()</function> always means the end of the
result set has been reached and it is unnecessary to call
<function role="capi">mysql_eof()</function>. When used with
<literal>mysql_store_result()</literal>,
@@ -2422,10 +2422,10 @@
On the other hand, if you use
<literal>mysql_use_result()</literal> to initiate a result set
retrieval, the rows of the set are obtained from the server one
- by one as you call <literal>mysql_fetch_row()</literal>
+ by one as you call <function role="capi">mysql_fetch_row()</function>
repeatedly. Because an error may occur on the connection during
this process, a <literal>NULL</literal> return value from
- <literal>mysql_fetch_row()</literal> does not necessarily mean
+ <function role="capi">mysql_fetch_row()</function> does not necessarily mean
the end of the result set was reached normally. In this case,
you can use <function role="capi">mysql_eof()</function> to determine what
happened. <function role="capi">mysql_eof()</function> returns a non-zero
@@ -2533,7 +2533,7 @@
<para>
Note that some functions like
- <literal>mysql_fetch_row()</literal> don't set
+ <function role="capi">mysql_fetch_row()</function> don't set
<function role="capi">mysql_errno()</function> if they succeed.
</para>
@@ -2700,15 +2700,15 @@
Returns the definition of one column of a result set as a
<literal>MYSQL_FIELD</literal> structure. Call this function
repeatedly to retrieve information about all columns in the
- result set. <literal>mysql_fetch_field()</literal> returns
+ result set. <function role="capi">mysql_fetch_field()</function> returns
<literal>NULL</literal> when no more fields are left.
</para>
<para>
- <literal>mysql_fetch_field()</literal> is reset to return
+ <function role="capi">mysql_fetch_field()</function> is reset to return
information about the first field each time you execute a new
<literal>SELECT</literal> query. The field returned by
- <literal>mysql_fetch_field()</literal> is also affected by calls
+ <function role="capi">mysql_fetch_field()</function> is also affected by calls
to <literal>mysql_field_seek()</literal>.
</para>
@@ -2717,7 +2717,7 @@
<literal>SELECT</literal> on a table but have not called
<literal>mysql_store_result()</literal>, MySQL returns the
default blob length (8KB) if you call
- <literal>mysql_fetch_field()</literal> to ask for the length of
+ <function role="capi">mysql_fetch_field()</function> to ask for the length of
a <literal>BLOB</literal> field. (The 8KB size is chosen because
MySQL doesn't know the maximum length for the
<literal>BLOB</literal>. This should be made configurable
@@ -2912,7 +2912,7 @@
The length for empty columns and for columns containing
<literal>NULL</literal> values is zero. To see how to
distinguish these two cases, see the description for
- <literal>mysql_fetch_row()</literal>.
+ <function role="capi">mysql_fetch_row()</function>.
</para>
<para>
@@ -2930,10 +2930,10 @@
</para>
<para>
- <literal>mysql_fetch_lengths()</literal> is valid only for the
+ <function role="capi">mysql_fetch_lengths()</function> is valid only for the
current row of the result set. It returns
<literal>NULL</literal> if you call it before calling
- <literal>mysql_fetch_row()</literal> or after retrieving all
+ <function role="capi">mysql_fetch_row()</function> or after retrieving all
rows in the result.
</para>
@@ -2981,10 +2981,10 @@
<para>
Retrieves the next row of a result set. When used after
<literal>mysql_store_result()</literal>,
- <literal>mysql_fetch_row()</literal> returns
+ <function role="capi">mysql_fetch_row()</function> returns
<literal>NULL</literal> when there are no more rows to retrieve.
When used after <literal>mysql_use_result()</literal>,
- <literal>mysql_fetch_row()</literal> returns
+ <function role="capi">mysql_fetch_row()</function> returns
<literal>NULL</literal> when there are no more rows to retrieve
or if an error occurred.
</para>
@@ -2993,7 +2993,7 @@
The number of values in the row is given by
<literal>mysql_num_fields(result)</literal>. If
<literal>row</literal> holds the return value from a call to
- <literal>mysql_fetch_row()</literal>, pointers to the values are
+ <function role="capi">mysql_fetch_row()</function>, pointers to the values are
accessed as <literal>row[0]</literal> to
<literal>row[mysql_num_fields(result)-1]</literal>.
<literal>NULL</literal> values in the row are indicated by
@@ -3002,7 +3002,7 @@
<para>
The lengths of the field values in the row may be obtained by
- calling <literal>mysql_fetch_lengths()</literal>. Empty fields
+ calling <function role="capi">mysql_fetch_lengths()</function>. Empty fields
and fields containing <literal>NULL</literal> both have length
0; you can distinguish these by checking the pointer for the
field value. If the pointer is <literal>NULL</literal>, the
@@ -3025,7 +3025,7 @@
<para>
Note that error is not reset between calls to
- <literal>mysql_fetch_row()</literal>
+ <function role="capi">mysql_fetch_row()</function>
</para>
<itemizedlist>
@@ -3201,7 +3201,7 @@
<para>
Sets the field cursor to the given offset. The next call to
- <literal>mysql_fetch_field()</literal> retrieves the field
+ <function role="capi">mysql_fetch_field()</function> retrieves the field
definition of the column associated with that offset.
</para>
@@ -3247,7 +3247,7 @@
<para>
Returns the position of the field cursor used for the last
- <literal>mysql_fetch_field()</literal>. This value can be used
+ <function role="capi">mysql_fetch_field()</function>. This value can be used
as an argument to <literal>mysql_field_seek()</literal>.
</para>
@@ -3894,7 +3894,7 @@
Otherwise, the object is initialized and the address of the
object is returned. If
<function role="capi">mysql_init()</function> allocates a new
- object, it is freed when <literal>mysql_close()</literal> is
+ object, it is freed when <function role="capi">mysql_close()</function> is
called to close the connection.
</para>
@@ -6951,7 +6951,7 @@
particular, if the value of <literal>completion_type</literal>
is 2, the server performs a release after terminating a
transaction and closes the client connection. The client program
- should call <literal>mysql_close()</literal> to close the
+ should call <function role="capi">mysql_close()</function> to close the
connection from the client side.
</para>
@@ -6993,8 +6993,8 @@
<para>
Sets the row cursor to an arbitrary row in a query result set.
The <literal>offset</literal> value is a row offset that should
- be a value returned from <literal>mysql_row_tell()</literal> or
- from <literal>mysql_row_seek()</literal>. This value is not a
+ be a value returned from <function role="capi">mysql_row_tell()</function> or
+ from <function role="capi">mysql_row_seek()</function>. This value is not a
row number; if you want to seek to a row within a result set by
number, use <literal>mysql_data_seek()</literal> instead.
</para>
@@ -7002,7 +7002,7 @@
<para>
This function requires that the result set structure contains
the entire result of the query, so
- <literal>mysql_row_seek()</literal> may be used only in
+ <function role="capi">mysql_row_seek()</function> may be used only in
conjunction with <literal>mysql_store_result()</literal>, not
with <literal>mysql_use_result()</literal>.
</para>
@@ -7013,7 +7013,7 @@
<para>
The previous value of the row cursor. This value may be passed
- to a subsequent call to <literal>mysql_row_seek()</literal>.
+ to a subsequent call to <function role="capi">mysql_row_seek()</function>.
</para>
<para>
@@ -7045,12 +7045,12 @@
<para>
Returns the current position of the row cursor for the last
- <literal>mysql_fetch_row()</literal>. This value can be used as
- an argument to <literal>mysql_row_seek()</literal>.
+ <function role="capi">mysql_fetch_row()</function>. This value can be used as
+ an argument to <function role="capi">mysql_row_seek()</function>.
</para>
<para>
- You should use <literal>mysql_row_tell()</literal> only after
+ You should use <function role="capi">mysql_row_tell()</function> only after
<literal>mysql_store_result()</literal>, not after
<literal>mysql_use_result()</literal>.
</para>
@@ -7982,9 +7982,9 @@
</para>
<para>
- You can call <literal>mysql_fetch_row()</literal> to fetch rows
- from the result set, or <literal>mysql_row_seek()</literal> and
- <literal>mysql_row_tell()</literal> to obtain or set the current
+ You can call <function role="capi">mysql_fetch_row()</function> to fetch rows
+ from the result set, or <function role="capi">mysql_row_seek()</function> and
+ <function role="capi">mysql_row_tell()</function> to obtain or set the current
row position within the result set.
</para>
@@ -8143,7 +8143,7 @@
retrieval but does not actually read the result set into the
client like <literal>mysql_store_result()</literal> does.
Instead, each row must be retrieved individually by making calls
- to <literal>mysql_fetch_row()</literal>. This reads the result
+ to <function role="capi">mysql_fetch_row()</function>. This reads the result
of a query directly from the server without storing it in a
temporary table or local buffer, which is somewhat faster and
uses much less memory than
@@ -8164,7 +8164,7 @@
<para>
When using <literal>mysql_use_result()</literal>, you must
- execute <literal>mysql_fetch_row()</literal> until a
+ execute <function role="capi">mysql_fetch_row()</function> until a
<literal>NULL</literal> value is returned, otherwise, the
unfetched rows are returned as part of the result set for your
next query. The C API gives the error <literal>Commands out of
@@ -8174,8 +8174,8 @@
<para>
You may not use <literal>mysql_data_seek()</literal>,
- <literal>mysql_row_seek()</literal>,
- <literal>mysql_row_tell()</literal>,
+ <function role="capi">mysql_row_seek()</function>,
+ <function role="capi">mysql_row_tell()</function>,
<literal>mysql_num_rows()</literal>, or
<function role="capi">mysql_affected_rows()</function> with a
result returned from <literal>mysql_use_result()</literal>, nor
@@ -11992,19 +11992,19 @@
<listitem>
<para>
- <literal>mysql_fetch_field()</literal>
+ <function role="capi">mysql_fetch_field()</function>
</para>
</listitem>
<listitem>
<para>
- <literal>mysql_fetch_field_direct()</literal>
+ <function role="capi">mysql_fetch_field_direct()</function>
</para>
</listitem>
<listitem>
<para>
- <literal>mysql_fetch_fields()</literal>
+ <function role="capi">mysql_fetch_fields()</function>
</para>
</listitem>
@@ -13524,7 +13524,7 @@
<literal>mysql_use_result()</literal>,
<literal>mysql_num_rows()</literal> may be called only after
you have fetched all the rows with
- <literal>mysql_fetch_row()</literal>.
+ <function role="capi">mysql_fetch_row()</function>.
</para>
</listitem>
Modified: trunk/refman-6.0/apis-c.xml
===================================================================
--- trunk/refman-6.0/apis-c.xml 2007-11-03 16:12:18 UTC (rev 8510)
+++ trunk/refman-6.0/apis-c.xml 2007-11-03 16:12:27 UTC (rev 8511)
Changed blocks: 35, Lines Added: 54, Lines Deleted: 54; 18171 bytes
@@ -921,7 +921,7 @@
<row>
<entry><function role="capi">mysql_field_tell()</function></entry>
<entry>Returns the position of the field cursor used for the last
- <literal>mysql_fetch_field()</literal></entry>
+ <function role="capi">mysql_fetch_field()</function></entry>
</row>
<row>
<entry><function role="capi">mysql_free_result()</function></entry>
@@ -1063,7 +1063,7 @@
<row>
<entry><function role="capi">mysql_row_seek()</function></entry>
<entry>Seeks to a row offset in a result set, using value returned from
- <literal>mysql_row_tell()</literal></entry>
+ <function role="capi">mysql_row_tell()</function></entry>
</row>
<row>
<entry><function role="capi">mysql_row_tell()</function></entry>
@@ -1188,7 +1188,7 @@
<listitem>
<para>
Close the connection to the MySQL server by calling
- <literal>mysql_close()</literal>.
+ <function role="capi">mysql_close()</function>.
</para>
</listitem>
@@ -1250,7 +1250,7 @@
<literal>MYSQL_OPT_RECONNECT</literal> option to
<function role="capi">mysql_options()</function> to control
reconnection behavior. When you are done with the connection, call
- <literal>mysql_close()</literal> to terminate it.
+ <function role="capi">mysql_close()</function> to terminate it.
</para>
<para>
@@ -1294,15 +1294,15 @@
<para>
In both cases, you access rows by calling
- <literal>mysql_fetch_row()</literal>. With
+ <function role="capi">mysql_fetch_row()</function>. With
<literal>mysql_store_result()</literal>,
- <literal>mysql_fetch_row()</literal> accesses rows that have
+ <function role="capi">mysql_fetch_row()</function> accesses rows that have
previously been fetched from the server. With
<literal>mysql_use_result()</literal>,
- <literal>mysql_fetch_row()</literal> actually retrieves the row
+ <function role="capi">mysql_fetch_row()</function> actually retrieves the row
from the server. Information about the size of the data in each
row is available by calling
- <literal>mysql_fetch_lengths()</literal>.
+ <function role="capi">mysql_fetch_lengths()</function>.
</para>
<para>
@@ -1323,7 +1323,7 @@
because the rows have all been fetched to the client, you not only
can access rows sequentially, you can move back and forth in the
result set using <literal>mysql_data_seek()</literal> or
- <literal>mysql_row_seek()</literal> to change the current row
+ <function role="capi">mysql_row_seek()</function> to change the current row
position within the result set. You can also find out how many
rows there are by calling <literal>mysql_num_rows()</literal>. On
the other hand, the memory requirements for
@@ -1376,15 +1376,15 @@
information about the fields that make up the result set (the
number of fields, their names and types, and so forth). You can
access field information sequentially within the row by calling
- <literal>mysql_fetch_field()</literal> repeatedly, or by field
+ <function role="capi">mysql_fetch_field()</function> repeatedly, or by field
number within the row by calling
- <literal>mysql_fetch_field_direct()</literal>. The current field
+ <function role="capi">mysql_fetch_field_direct()</function>. The current field
cursor position may be changed by calling
<literal>mysql_field_seek()</literal>. Setting the field cursor
affects subsequent calls to
- <literal>mysql_fetch_field()</literal>. You can also get
+ <function role="capi">mysql_fetch_field()</function>. You can also get
information for fields all at once by calling
- <literal>mysql_fetch_fields()</literal>.
+ <function role="capi">mysql_fetch_fields()</function>.
</para>
<para>
@@ -1809,7 +1809,7 @@
<para>
Closes a previously opened connection.
- <literal>mysql_close()</literal> also deallocates the connection
+ <function role="capi">mysql_close()</function> also deallocates the connection
handle pointed to by <literal>mysql</literal> if the handle was
allocated automatically by
<function role="capi">mysql_init()</function> or
@@ -1860,7 +1860,7 @@
particular, if the value of <literal>completion_type</literal>
is 2, the server performs a release after terminating a
transaction and closes the client connection. The client program
- should call <literal>mysql_close()</literal> to close the
+ should call <function role="capi">mysql_close()</function> to close the
connection from the client side.
</para>
@@ -1925,7 +1925,7 @@
difference that the connection parameter may be
<literal>NULL</literal>. In this case, the C API allocates
memory for the connection structure automatically and frees it
- when you call <literal>mysql_close()</literal>. The disadvantage
+ when you call <function role="capi">mysql_close()</function>. The disadvantage
of this approach is that you can't retrieve an error message if
the connection fails. (To get error information from
<function role="capi">mysql_errno()</function> or
@@ -2379,7 +2379,7 @@
<literal>mysql_store_result()</literal>, the client receives the
entire set in one operation. In this case, a
<literal>NULL</literal> return from
- <literal>mysql_fetch_row()</literal> always means the end of the
+ <function role="capi">mysql_fetch_row()</function> always means the end of the
result set has been reached and it is unnecessary to call
<function role="capi">mysql_eof()</function>. When used with
<literal>mysql_store_result()</literal>,
@@ -2390,10 +2390,10 @@
On the other hand, if you use
<literal>mysql_use_result()</literal> to initiate a result set
retrieval, the rows of the set are obtained from the server one
- by one as you call <literal>mysql_fetch_row()</literal>
+ by one as you call <function role="capi">mysql_fetch_row()</function>
repeatedly. Because an error may occur on the connection during
this process, a <literal>NULL</literal> return value from
- <literal>mysql_fetch_row()</literal> does not necessarily mean
+ <function role="capi">mysql_fetch_row()</function> does not necessarily mean
the end of the result set was reached normally. In this case,
you can use <function role="capi">mysql_eof()</function> to determine what
happened. <function role="capi">mysql_eof()</function> returns a non-zero
@@ -2501,7 +2501,7 @@
<para>
Note that some functions like
- <literal>mysql_fetch_row()</literal> don't set
+ <function role="capi">mysql_fetch_row()</function> don't set
<function role="capi">mysql_errno()</function> if they succeed.
</para>
@@ -2668,15 +2668,15 @@
Returns the definition of one column of a result set as a
<literal>MYSQL_FIELD</literal> structure. Call this function
repeatedly to retrieve information about all columns in the
- result set. <literal>mysql_fetch_field()</literal> returns
+ result set. <function role="capi">mysql_fetch_field()</function> returns
<literal>NULL</literal> when no more fields are left.
</para>
<para>
- <literal>mysql_fetch_field()</literal> is reset to return
+ <function role="capi">mysql_fetch_field()</function> is reset to return
information about the first field each time you execute a new
<literal>SELECT</literal> query. The field returned by
- <literal>mysql_fetch_field()</literal> is also affected by calls
+ <function role="capi">mysql_fetch_field()</function> is also affected by calls
to <literal>mysql_field_seek()</literal>.
</para>
@@ -2685,7 +2685,7 @@
<literal>SELECT</literal> on a table but have not called
<literal>mysql_store_result()</literal>, MySQL returns the
default blob length (8KB) if you call
- <literal>mysql_fetch_field()</literal> to ask for the length of
+ <function role="capi">mysql_fetch_field()</function> to ask for the length of
a <literal>BLOB</literal> field. (The 8KB size is chosen because
MySQL doesn't know the maximum length for the
<literal>BLOB</literal>. This should be made configurable
@@ -2880,7 +2880,7 @@
The length for empty columns and for columns containing
<literal>NULL</literal> values is zero. To see how to
distinguish these two cases, see the description for
- <literal>mysql_fetch_row()</literal>.
+ <function role="capi">mysql_fetch_row()</function>.
</para>
<para>
@@ -2898,10 +2898,10 @@
</para>
<para>
- <literal>mysql_fetch_lengths()</literal> is valid only for the
+ <function role="capi">mysql_fetch_lengths()</function> is valid only for the
current row of the result set. It returns
<literal>NULL</literal> if you call it before calling
- <literal>mysql_fetch_row()</literal> or after retrieving all
+ <function role="capi">mysql_fetch_row()</function> or after retrieving all
rows in the result.
</para>
@@ -2949,10 +2949,10 @@
<para>
Retrieves the next row of a result set. When used after
<literal>mysql_store_result()</literal>,
- <literal>mysql_fetch_row()</literal> returns
+ <function role="capi">mysql_fetch_row()</function> returns
<literal>NULL</literal> when there are no more rows to retrieve.
When used after <literal>mysql_use_result()</literal>,
- <literal>mysql_fetch_row()</literal> returns
+ <function role="capi">mysql_fetch_row()</function> returns
<literal>NULL</literal> when there are no more rows to retrieve
or if an error occurred.
</para>
@@ -2961,7 +2961,7 @@
The number of values in the row is given by
<literal>mysql_num_fields(result)</literal>. If
<literal>row</literal> holds the return value from a call to
- <literal>mysql_fetch_row()</literal>, pointers to the values are
+ <function role="capi">mysql_fetch_row()</function>, pointers to the values are
accessed as <literal>row[0]</literal> to
<literal>row[mysql_num_fields(result)-1]</literal>.
<literal>NULL</literal> values in the row are indicated by
@@ -2970,7 +2970,7 @@
<para>
The lengths of the field values in the row may be obtained by
- calling <literal>mysql_fetch_lengths()</literal>. Empty fields
+ calling <function role="capi">mysql_fetch_lengths()</function>. Empty fields
and fields containing <literal>NULL</literal> both have length
0; you can distinguish these by checking the pointer for the
field value. If the pointer is <literal>NULL</literal>, the
@@ -2993,7 +2993,7 @@
<para>
Note that error is not reset between calls to
- <literal>mysql_fetch_row()</literal>
+ <function role="capi">mysql_fetch_row()</function>
</para>
<itemizedlist>
@@ -3169,7 +3169,7 @@
<para>
Sets the field cursor to the given offset. The next call to
- <literal>mysql_fetch_field()</literal> retrieves the field
+ <function role="capi">mysql_fetch_field()</function> retrieves the field
definition of the column associated with that offset.
</para>
@@ -3215,7 +3215,7 @@
<para>
Returns the position of the field cursor used for the last
- <literal>mysql_fetch_field()</literal>. This value can be used
+ <function role="capi">mysql_fetch_field()</function>. This value can be used
as an argument to <literal>mysql_field_seek()</literal>.
</para>
@@ -3858,7 +3858,7 @@
Otherwise, the object is initialized and the address of the
object is returned. If
<function role="capi">mysql_init()</function> allocates a new
- object, it is freed when <literal>mysql_close()</literal> is
+ object, it is freed when <function role="capi">mysql_close()</function> is
called to close the connection.
</para>
@@ -6894,7 +6894,7 @@
particular, if the value of <literal>completion_type</literal>
is 2, the server performs a release after terminating a
transaction and closes the client connection. The client program
- should call <literal>mysql_close()</literal> to close the
+ should call <function role="capi">mysql_close()</function> to close the
connection from the client side.
</para>
@@ -6936,8 +6936,8 @@
<para>
Sets the row cursor to an arbitrary row in a query result set.
The <literal>offset</literal> value is a row offset that should
- be a value returned from <literal>mysql_row_tell()</literal> or
- from <literal>mysql_row_seek()</literal>. This value is not a
+ be a value returned from <function role="capi">mysql_row_tell()</function> or
+ from <function role="capi">mysql_row_seek()</function>. This value is not a
row number; if you want to seek to a row within a result set by
number, use <literal>mysql_data_seek()</literal> instead.
</para>
@@ -6945,7 +6945,7 @@
<para>
This function requires that the result set structure contains
the entire result of the query, so
- <literal>mysql_row_seek()</literal> may be used only in
+ <function role="capi">mysql_row_seek()</function> may be used only in
conjunction with <literal>mysql_store_result()</literal>, not
with <literal>mysql_use_result()</literal>.
</para>
@@ -6956,7 +6956,7 @@
<para>
The previous value of the row cursor. This value may be passed
- to a subsequent call to <literal>mysql_row_seek()</literal>.
+ to a subsequent call to <function role="capi">mysql_row_seek()</function>.
</para>
<para>
@@ -6988,12 +6988,12 @@
<para>
Returns the current position of the row cursor for the last
- <literal>mysql_fetch_row()</literal>. This value can be used as
- an argument to <literal>mysql_row_seek()</literal>.
+ <function role="capi">mysql_fetch_row()</function>. This value can be used as
+ an argument to <function role="capi">mysql_row_seek()</function>.
</para>
<para>
- You should use <literal>mysql_row_tell()</literal> only after
+ You should use <function role="capi">mysql_row_tell()</function> only after
<literal>mysql_store_result()</literal>, not after
<literal>mysql_use_result()</literal>.
</para>
@@ -7925,9 +7925,9 @@
</para>
<para>
- You can call <literal>mysql_fetch_row()</literal> to fetch rows
- from the result set, or <literal>mysql_row_seek()</literal> and
- <literal>mysql_row_tell()</literal> to obtain or set the current
+ You can call <function role="capi">mysql_fetch_row()</function> to fetch rows
+ from the result set, or <function role="capi">mysql_row_seek()</function> and
+ <function role="capi">mysql_row_tell()</function> to obtain or set the current
row position within the result set.
</para>
@@ -8086,7 +8086,7 @@
retrieval but does not actually read the result set into the
client like <literal>mysql_store_result()</literal> does.
Instead, each row must be retrieved individually by making calls
- to <literal>mysql_fetch_row()</literal>. This reads the result
+ to <function role="capi">mysql_fetch_row()</function>. This reads the result
of a query directly from the server without storing it in a
temporary table or local buffer, which is somewhat faster and
uses much less memory than
@@ -8107,7 +8107,7 @@
<para>
When using <literal>mysql_use_result()</literal>, you must
- execute <literal>mysql_fetch_row()</literal> until a
+ execute <function role="capi">mysql_fetch_row()</function> until a
<literal>NULL</literal> value is returned, otherwise, the
unfetched rows are returned as part of the result set for your
next query. The C API gives the error <literal>Commands out of
@@ -8117,8 +8117,8 @@
<para>
You may not use <literal>mysql_data_seek()</literal>,
- <literal>mysql_row_seek()</literal>,
- <literal>mysql_row_tell()</literal>,
+ <function role="capi">mysql_row_seek()</function>,
+ <function role="capi">mysql_row_tell()</function>,
<literal>mysql_num_rows()</literal>, or
<function role="capi">mysql_affected_rows()</function> with a
result returned from <literal>mysql_use_result()</literal>, nor
@@ -11907,19 +11907,19 @@
<listitem>
<para>
- <literal>mysql_fetch_field()</literal>
+ <function role="capi">mysql_fetch_field()</function>
</para>
</listitem>
<listitem>
<para>
- <literal>mysql_fetch_field_direct()</literal>
+ <function role="capi">mysql_fetch_field_direct()</function>
</para>
</listitem>
<listitem>
<para>
- <literal>mysql_fetch_fields()</literal>
+ <function role="capi">mysql_fetch_fields()</function>
</para>
</listitem>
@@ -13423,7 +13423,7 @@
<literal>mysql_use_result()</literal>,
<literal>mysql_num_rows()</literal> may be called only after
you have fetched all the rows with
- <literal>mysql_fetch_row()</literal>.
+ <function role="capi">mysql_fetch_row()</function>.
</para>
</listitem>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8511 - in trunk: . refman-5.0 refman-5.1 refman-6.0 | paul | 3 Nov |
