summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_dyncol_check.3
blob: 5b425e315db98ae533a6ac9e7c363168622c71b7 (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
.\" Automatically generated by Pandoc 2.5
.\"
.TH "mariadb_dyncol_check" "3" "" "Version 3.3.1" "MariaDB Connector/C"
.hy
.SS Name
.PP
mariadb_dyncol_check \- Checks if a dynamic column has correct format
.SS Synopsis
.IP
.nf
\f[C]
#include <mariadb_dyncol.h>

enum enum_dyncol_func_result
mariadb_dyncol_check(DYNAMIC_COLUMN *str);
\f[R]
.fi
.SS Description
.PP
The function \f[C]mariadb_dyncol_check()\f[R] checks if a dynamic column
has correct format.
This can be used e.g.\ to check if a blob contains a dynamic column.
.SS Parameter
.IP \[bu] 2
\f[C]str\f[R]\- pointer to a \f[C]DYNAMIC_COLUMN\f[R] structure.
.SS Return value
.PP
Returns \f[C]ER_DYNCOL_OK\f[R] if the dynamic column has correct format,
otherwise \f[C]ER_DYNCOL_FORMAT\f[R].
.SS See also
.IP \[bu] 2
\f[B]mariadb_dyncol_count(3)\f[R]