Files
mariadb-connector-c/man/mysql_stmt_send_long_data.3
Georg Richter 10c67ee835 Man page fixes:
- Install created man pages when building with WITH_DOCS=ON
- Set version to 3.4
2024-10-25 10:37:47 +02:00

46 lines
1.5 KiB
Groff

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mysql_stmt_send_long_data" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mysql_stmt_send_long_data \- Sends data in chunks
.SS Synopsis
.IP
.EX
#include \f[B]<mysql.h>\f[R]
my_bool mysql_stmt_send_long_data(MYSQL_STMT * stmt,
unsigned int,
const char * data,
unsigned long);
.EE
.SS Description
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[CR]TEXT\f[R] or \f[CR]BLOB\f[R] datatypes.
.SS Parameter
.IP \[bu] 2
\f[CR]stmt\f[R] \- a statement handle, which was previously allocated by
\f[B]mysql_stmt_init(3)\f[R].
.IP \[bu] 2
\f[CR]param_no\f[R] \- indicates which parameter to associate the data
with.
Parameters are numbered beginning with 0.
.IP \[bu] 2
\f[CR]data\f[R] \- a buffer containing the data to send.
.IP \[bu] 2
\f[CR]long\f[R] \- size of the data buffer.
.SS Return value
Returns zero on success, nonzero if an error occurred.
.SS Notes
.IP \[bu] 2
\f[CR]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].