File: mariadb_dyncol_unpack.3

package info (click to toggle)
mariadb 1%3A11.8.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 772,520 kB
  • sloc: ansic: 2,414,714; cpp: 1,791,394; asm: 381,336; perl: 62,905; sh: 49,647; pascal: 40,897; java: 39,363; python: 20,791; yacc: 20,432; sql: 17,907; xml: 12,344; ruby: 8,544; cs: 6,542; makefile: 6,145; ada: 1,879; lex: 1,193; javascript: 996; objc: 80; tcl: 73; awk: 46; php: 22
file content (45 lines) | stat: -rw-r--r-- 1,423 bytes parent folder | download | duplicates (2)
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
.\" Automatically generated by Pandoc 3.5
.\"
.TH "mariadb_dyncol_unpack" "3" "" "Version 3.4" "MariaDB Connector/C"
.SS Name
mariadb_dyncol_unpack \- extracts keys and values of all columns
.SS Synopsis
.IP
.EX
#include \f[B]<mariadb_dyncol.h>\f[R]

\f[B]enum\f[R] enum_dyncol_func_result
mariadb_dyncol_unpack(DYNAMIC_COLUMN *str,
                      uint *column_count,
                      MYSQL_LEX_STRING **column_keys,
                      DYNAMIC_COLUMN_VALUE **values);
.EE
.SS Description
The \f[CR]mariadb_dyncol_unpack()\f[R] function extracts all keys and
values of a dynamic column.
.SS Parameter
.IP \[bu] 2
\f[CR]str\f[R] \- Pointer to a \f[CR]DYNAMIC_COLUMN\f[R] structure
.IP \[bu] 2
\f[CR]column count\f[R] \- Pointer to an unsigned integer which will
receive the number of columns
.IP \[bu] 2
\f[CR]column_keys\f[R] \- Pointer of an array of
\f[CR]MYSQL_LEX_STRING\f[R] structures, which will contain the column
keys
.IP \[bu] 2
\f[CR]values\f[R] \- Pointer of an array of
\f[CR]DYNAMIC_COLUMN_VALUE\f[R] structures, which will contain the
values.
.SS Return value
Returns \f[CR]ER_DYNCOL_OK\f[R] on success, otherwise an error.
.SS Notes
.IP \[bu] 2
The \f[CR]column_keys\f[R] and \f[CR]values\f[R] arrays will be
allocated by \f[CR]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]