summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_dyncol_list_named.3
blob: 64b2cc5eac96db1b45d7ec83c8be1d46123f0ce5 (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
.\" 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>