File: msqlFetchRow.3

package info (click to toggle)
msql 2.0.3-5
  • links: PTS
  • area: non-free
  • in suites: hamm, slink
  • size: 3,596 kB
  • ctags: 2,483
  • sloc: ansic: 34,769; sh: 1,309; yacc: 1,084; perl: 328; makefile: 267
file content (61 lines) | stat: -rw-r--r-- 1,970 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.\" msqlFetchRow - Fetch one row out of a query result
.\" Copyright (c) 1996  Martin Schulze <joey@office.individual.net>
.\" 
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\" 
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\" 
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc.,59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\"
.\" This manual page is written especially for Debian GNU/Linux.
.\"
.TH msqlFetchRow 3 "4 Aug 1996" "Mini SQL" "mSQL Programmer's Manual"
.SH NAME
msqlFetchRow \- Fetch one row out of a query result
.SH SYNOPSYS
.nf
.B #include <msql.h>
.sp
.BI "m_row msqlFetchRow(m_result *" result );
.fi
.SH DESCRIPTION
The individual database rows returned by a SELECT are accessed via the
.B msqlFetchRow()
function.  The data is returned in a variable of type
.I m_row
which contains a char pointer for each field in the row.  For example,
if a select statement selected 3 fields from each row returned, the
value of the 3 fields would be assigned to elements [0], [1] and [2]
of the variable returned by
.BR msqlFetchRow() .
A value of NULL is returned when the end of the data has been reached.

The
.I m_row
datastructure is defined in
.I <msql.h>
as follows:

.RS
.nf
.ta 8n 16n 32n
typedef	char	**m_row;
.fi
.SH "RETURN VALUE"
On success a
.I m_row
datastructure is returned.  If the end of the data es reached a value of
NULL is returned.

.SH "SEE ALSO"
.BR msqlQuery (3),
.BR msqlStoreResult (3),
.BR msql (5).