summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_dyncol_list_named.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:24:36 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:24:36 +0000
commit06eaf7232e9a920468c0f8d74dcf2fe8b555501c (patch)
treee2c7b5777f728320e5b5542b6213fd3591ba51e2 /libmariadb/man/mariadb_dyncol_list_named.3
parentInitial commit. (diff)
downloadmariadb-06eaf7232e9a920468c0f8d74dcf2fe8b555501c.tar.xz
mariadb-06eaf7232e9a920468c0f8d74dcf2fe8b555501c.zip
Adding upstream version 1:10.11.6.upstream/1%10.11.6
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'libmariadb/man/mariadb_dyncol_list_named.3')
-rw-r--r--libmariadb/man/mariadb_dyncol_list_named.343
1 files changed, 43 insertions, 0 deletions
diff --git a/libmariadb/man/mariadb_dyncol_list_named.3 b/libmariadb/man/mariadb_dyncol_list_named.3
new file mode 100644
index 00000000..64b2cc5e
--- /dev/null
+++ b/libmariadb/man/mariadb_dyncol_list_named.3
@@ -0,0 +1,43 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mariadb_dyncol_list_named" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mariadb_dyncol_list_named \- Lists column keys in dynamic column
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mariadb_dyncol.h>
+
+enum enum_dyncol_func_result
+mariadb_dyncol_list_named(DYNAMIC_COLUMN *str,
+ uint *column_count,
+ MYSQL_LEX_STRING **column_keys);
+\f[R]
+.fi
+.SS Description
+.PP
+Lists the column keys inside a dynamic column.
+.SS Notes
+.IP \[bu] 2
+The application program needs to free the allocated memory for
+\f[C]column_count\f[R] and \f[C]column_keys\f[R] parameter.
+.SS Parameter
+.IP \[bu] 2
+\f[C]*str\f[R] \- Dynamic column
+.IP \[bu] 2
+\f[C]*column_count\f[R] \- A pointer to an unsigned integer which stores
+the number of columns
+.IP \[bu] 2
+\f[C]**column_keys\f[R] \- A pointer to an array of column keys, which
+stores the keys
+.SS Return value
+.PP
+Returns \f[C]ER_DYNCOL_OK\f[R] on success, otherwise error.
+.SS See also
+.IP \[bu] 2
+<mariadb_dyncol_list_num>
+.IP \[bu] 2
+<mariadb_dyncol_list_json>