blob: 57b80d4c81a1f429ff349647a13b7ee0a8fc2cca (
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
44
45
46
47
48
49
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]
|
