You've already forked mariadb-connector-c
mirror of
https://github.com/mariadb-corporation/mariadb-connector-c.git
synced 2025-08-08 14:02:17 +03:00
46 lines
1.4 KiB
Groff
46 lines
1.4 KiB
Groff
.\" 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]
|