summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_stmt_send_long_data.3
blob: 4955d144e021c4c69b733cd7f1b8fa256c14e479 (plain)
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
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mysql_stmt_send_long_data" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mysql_stmt_send_long_data \- Sends data in chunks
.SS Synopsis
.IP
.nf
\f[C]
#include <mysql.h>

my_bool mysql_stmt_send_long_data(MYSQL_STMT * stmt,
                                  unsigned int,
                                  const char * data,
                                  unsigned long);
\f[R]
.fi
.SS Description
.PP
Allows sending parameter data to the server in pieces (or chunks),
e.g.\ if the size of a blob exceeds the size of max_allowed_packet size.
This function can be called multiple times to send the parts of a
character or binary data value for a column, which must be one of the
\f[C]TEXT\f[R] or \f[C]BLOB\f[R] datatypes.
.SS Parameter
.IP \[bu] 2
\f[C]stmt\f[R] \- a statement handle, which was previously allocated by
\f[B]mysql_stmt_init(3)\f[R].
.IP \[bu] 2
\f[C]param_no\f[R] \- indicates which parameter to associate the data
with.
Parameters are numbered beginning with 0.
.IP \[bu] 2
\f[C]data\f[R] \- a buffer containing the data to send.
.IP \[bu] 2
\f[C]long\f[R] \- size of the data buffer.
.SS Return value
.PP
Returns zero on success, nonzero if an error occurred.
.SS Notes
.IP \[bu] 2
\f[C]mysql_stmt_send_long_data()\f[R] must be called before
\f[B]mysql_stmt_execute(3)\f[R].
.IP \[bu] 2
bound variables for this column will be ignored when calling
\f[B]mysql_stmt_execute(3)\f[R].
.SS See also
.IP \[bu] 2
\f[B]mysql_stmt_execute(3)\f[R].