-
Notifications
You must be signed in to change notification settings - Fork 3
/
ksql_stmt_double.3
117 lines (117 loc) · 2.86 KB
/
ksql_stmt_double.3
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
.\" $Id$
.\"
.\" Copyright (c) 2016, 2018 Kristaps Dzonsons <kristaps@bsd.lv>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd $Mdocdate$
.Dt KSQL_STMT_DOUBLE 3
.Os
.Sh NAME
.Nm ksql_stmt_blob ,
.Nm ksql_stmt_bytes ,
.Nm ksql_stmt_double ,
.Nm ksql_stmt_int ,
.Nm ksql_stmt_isnull ,
.Nm ksql_stmt_str
.Nd get the result columns of a statement
.Sh LIBRARY
.Lb ksql
.Sh SYNOPSIS
.In sys/types.h
.In stdint.h
.In ksql.h
.Ft "const void *"
.Fo ksql_stmt_blob
.Fa "struct ksqlstmt *stmt"
.Fa "size_t column"
.Fc
.Ft size_t
.Fo ksql_stmt_bytes
.Fa "struct ksqlstmt *stmt"
.Fa "size_t column"
.Fc
.Ft double
.Fo ksql_stmt_double
.Fa "struct ksqlstmt *stmt"
.Fa "size_t column"
.Fc
.Ft int64_t
.Fo ksql_stmt_int
.Fa "struct ksqlstmt *stmt"
.Fa "size_t column"
.Fc
.Ft int
.Fo ksql_stmt_isnull
.Fa "struct ksqlstmt *stmt"
.Fa "size_t column"
.Fc
.Ft "const char *"
.Fo ksql_stmt_str
.Fa "struct ksqlstmt *stmt"
.Fa "size_t column"
.Fc
.Sh DESCRIPTION
.Em All of these functions will soon be deprecated.
See
.Xr ksql_result_double 3
for replacements.
.Pp
These functions
functions return results following
.Xr ksql_stmt_step 3 .
They all accept
.Fa stmt ,
the statement allocated with
.Xr ksql_stmt_alloc 3 ;
and the
.Fa column
to query, which starts at zero.
The results are not defined for a statement without a resulting row or
for columns beyond the prepared statement.
.Pp
The
.Fn ksql_stmt_str
and
.Fn ksql_stmt_blob
functions return memory tha tmust be copied prior to subsequent
.Xr ksql_stmt_step 3 ,
.Xr ksql_stmt_reset 3 ,
or
.Xr ksql_stmt_free 3 .
.\" .Sh CONTEXT
.\" For section 9 functions only.
.\" .Sh IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .Sh RETURN VALUES
.\" For sections 2, 3, and 9 function return values only.
.\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only.
.\" .Sh FILES
.\" .Sh EXIT STATUS
.\" For sections 1, 6, and 8 only.
.\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.\" .Sh ERRORS
.\" For sections 2, 3, 4, and 9 errno settings only.
.Sh SEE ALSO
.Xr sqlite3_column_blob 3
.\" .Xr foobar 1
.\" .Sh STANDARDS
.\" .Sh HISTORY
.\" .Sh AUTHORS
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.