Adding upstream version 1:10.11.6.upstream/1%10.11.6

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 97 insertions, 0 deletions

diff --git a/libmariadb/man/mysql_stmt_attr_get.3 b/libmariadb/man/mysql_stmt_attr_get.3
new file mode 100644
index 00000000..2dd07a74
--- /dev/null
+++ b/libmariadb/man/mysql_stmt_attr_get.3
@@ -0,0 +1,97 @@
+.\"t
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_stmt_attr_get" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_stmt_attr_get \- Gets the current value of a statement attribute
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+
+my_bool mysql_stmt_attr_get(MYSQL_STMT * stmt,
+                            enum enum_stmt_attr_type,
+                            void * attr);
+\f[R]
+.fi
+.SS Description
+.PP
+Gets the current value of a statement attribute.
+Returns zero on success, non zero on failure.
+.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]enum_stmt_attr_type\f[R] \- attribute.
+See below.
+.IP \[bu] 2
+\f[C]attr\f[R] \- pointer to a variable, which will contain the
+attribute value.
+.SS Attribute types
+.PP
+The \f[C]enum_stmt_attr_type\f[R] parameter has the following possible
+values:
+.PP
+.TS
+tab(@);
+lw(23.3n) lw(23.3n) lw(23.3n).
+T{
+Value
+T}@T{
+Type
+T}@T{
+Description
+T}
+_
+T{
+\f[C]STMT_ATTR_UPDATE_MAX_LENGTH\f[R]
+T}@T{
+\f[C]my_bool *\f[R]
+T}@T{
+Indicates if \f[B]mysql_stmt_store_result(3)\f[R] will update the
+max_length value of \f[C]MYSQL_FIELD\f[R] structures.
+T}
+T{
+\f[C]STMT_ATTR_CURSOR_TYPE\f[R]
+T}@T{
+\f[C]unsigned long *\f[R]
+T}@T{
+Possible values are \f[C]CURSOR_TYPE_READ_ONLY\f[R] or default value
+\f[C]CURSOR_TYPE_NO_CURSOR\f[R].
+T}
+T{
+\f[C]STMT_ATTR_PREFETCH_ROWS\f[R]
+T}@T{
+\f[C]unsigned long *\f[R]
+T}@T{
+Number of rows which will be prefetched.
+The default value is 1.
+T}
+T{
+\f[C]STMT_ATTR_PREBIND_PARAMS\f[R]
+T}@T{
+\f[C]unsigned int *\f[R]
+T}@T{
+Number of parameters used for \f[B]mariadb_stmt_execute_direct(3)\f[R]
+T}
+T{
+\f[C]STMT_ATTR_STATE\f[R]
+T}@T{
+\f[C]enum mysql_stmt_state *\f[R]
+T}@T{
+Status of prepared statement.
+Possible values are defined in \f[C]enum mysql_stmt_state\f[R].
+This option was added in MariaDB Connector/C 3.1.0
+T}
+.TE
+.SS Notes
+.IP \[bu] 2
+Setting the number of prefetched rows will work only for read only
+cursors.
+.SS See Also
+.IP \[bu] 2
+\f[B]mysql_stmt_attr_set(3)\f[R]