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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
.\" msqlFetchField - Get field information about 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 msqlFetchField 3 "4 Aug 1996" "Mini SQL" "mSQL Programmer's Manual"
.SH NAME
msqlFetchField \- Get field information about query result
.SH SYNOPSYS
.nf
.B #include <msql.h>
.sp
.BI "m_field *msqlFetchField(m_result *" result );
.fi
.SH DESCRIPTION
Along with the actual data rows, the server returns information about
the data fields selected. This information is made available to the
calling program via the
.B msqlFetchField()
function. Like
.BR msqlFetchRow (3),
this function returns one element of information at a time and returns
NULL when no further information is available.
The data is returned in a
.I m_field
structure which is defined in
.I <msql.h>
as follows:
.RS
.nf
.ta 8n 16n 32n
typedef struct field_s {
char *name, /* name of field */
*table; /* name of table */
int type, /* data type of field */
length, /* length in bytes of field */
flags; /* attribute flags */
} m_field;
.fi
.RE
Possible values for the type field are also defined in
.I <msql.h>
as
.BR INT_TYPE ", " CHAR_TYPE " and " REAL_TYPE .
The individual attribute flags can be accessed using the following
macros:
.RS
.nf
.ta 8n 16n 32n
IS_PRI_KEY(flags) /* Field is the primary key */
IS_NOT_NULL(flags) /* Field may not contain a NULL value */
.fi
.SH "RETURN VALUE"
On success a pointer to an
.I m_field
structure is returned and a NULL pointer if no further data is available.
.SH "SEE ALSO"
.BR msqlQuery (3),
.BR msqlStoreResult (3),
.BR msqlFetchRow (3),
.BR msqlFetchField (3),
.BR msql (5).
|
