1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2024-11-08 08:47:17 +01:00
SqMod/vendor/MDBC/man/mysql_fetch_row.3
2021-09-21 20:59:01 +03:00

45 lines
1.3 KiB
Groff

.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_fetch_row" "3" "" "Version 3.2.2" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_fetch_row \- fetches row of data from result set
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>
MYSQL_ROW mysql_fetch_row(MYSQL_RES * result);
\f[R]
.fi
.SS Description
.PP
Fetches one row of data from the result set and returns it as an array
of char pointers (\f[C]MYSQL_ROW\f[R]), where each column is stored in
an offset starting from 0 (zero).
Each subsequent call to this function will return the next row within
the result set, or NULL if there are no more rows.
.SS Parameter
.IP \[bu] 2
\f[C]result\f[R] \- a result set identifier returned by
\f[B]mysql_store_result(3)\f[R] or \f[B]mysql_use_result(3)\f[R].
.SS Notes
.IP \[bu] 2
If a column contains a \f[C]NULL\f[R] value the corresponding char
pointer will be set to \f[C]NULL\f[R].
.IP \[bu] 2
Memory associated to \f[C]MYSQL_ROW\f[R] will be freed when calling
\f[B]mysql_free_result(3)\f[R] function.
.SS Return value
.PP
A \f[C]MYSQL_ROW\f[R] structure (array of character pointers)
representing the data of the current row.
If there are no more rows available \f[C]NULL\f[R]will be returned.
.SS See also
.IP \[bu] 2
\f[B]mysql_use_result(3)\f[R]
.IP \[bu] 2
\f[B]mysql_store_result(3)\f[R]