1
0
mirror of https://github.com/mariadb-corporation/mariadb-connector-c.git synced 2025-08-08 14:02:17 +03:00
Files
mariadb-connector-c/man/mariadb_dyncol_check.3
2024-10-25 07:38:00 +02:00

27 lines
802 B
Groff

.\" Automatically generated by Pandoc 3.5
.\"
.TH "mariadb_dyncol_check" "3" "" "Version 3.3" "MariaDB Connector/C"
.SS Name
mariadb_dyncol_check \- Checks if a dynamic column has correct format
.SS Synopsis
.IP
.EX
#include \f[B]<mariadb_dyncol.h>\f[R]
\f[B]enum\f[R] enum_dyncol_func_result
mariadb_dyncol_check(DYNAMIC_COLUMN *str);
.EE
.SS Description
The function \f[CR]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[CR]str\f[R]\- pointer to a \f[CR]DYNAMIC_COLUMN\f[R] structure.
.SS Return value
Returns \f[CR]ER_DYNCOL_OK\f[R] if the dynamic column has correct
format, otherwise \f[CR]ER_DYNCOL_FORMAT\f[R].
.SS See also
.IP \[bu] 2
\f[B]mariadb_dyncol_count(3)\f[R]