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, 50 insertions, 0 deletions

diff --git a/libmariadb/man/mariadb_dyncol_unpack.3 b/libmariadb/man/mariadb_dyncol_unpack.3
new file mode 100644
index 00000000..57b80d4c
--- /dev/null
+++ b/libmariadb/man/mariadb_dyncol_unpack.3
@@ -0,0 +1,50 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mariadb_dyncol_unpack" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mariadb_dyncol_unpack \- extracts keys and values of all columns
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mariadb_dyncol.h>
+
+enum enum_dyncol_func_result
+mariadb_dyncol_unpack(DYNAMIC_COLUMN *str,
+                      uint *column_count,
+                      MYSQL_LEX_STRING **column_keys,
+                      DYNAMIC_COLUMN_VALUE **values);
+\f[R]
+.fi
+.SS Description
+.PP
+The \f[C]mariadb_dyncol_unpack()\f[R] function extracts all keys and
+values of a dynamic column.
+.SS Parameter
+.IP \[bu] 2
+\f[C]str\f[R] \- Pointer to a \f[C]DYNAMIC_COLUMN\f[R] structure
+.IP \[bu] 2
+\f[C]column count\f[R] \- Pointer to an unsigned integer which will
+receive the number of columns
+.IP \[bu] 2
+\f[C]column_keys\f[R] \- Pointer of an array of
+\f[C]MYSQL_LEX_STRING\f[R] structures, which will contain the column
+keys
+.IP \[bu] 2
+\f[C]values\f[R] \- Pointer of an array of
+\f[C]DYNAMIC_COLUMN_VALUE\f[R] structures, which will contain the
+values.
+.SS Return value
+.PP
+Returns \f[C]ER_DYNCOL_OK\f[R] on success, otherwise an error.
+.SS Notes
+.IP \[bu] 2
+The \f[C]column_keys\f[R] and \f[C]values\f[R] arrays will be allocated
+by \f[C]mariadb_dyncol_unpack()\f[R] and must be freed by application.
+.SS See also
+.IP \[bu] 2
+\f[B]mariadb_dyncol_get(3)\f[R]
+.IP \[bu] 2
+\f[B]mariadb_dyncol_list(3)\f[R]