summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mariadb_dyncol_check.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mariadb_dyncol_check.3')
-rw-r--r--libmariadb/man/mariadb_dyncol_check.332
1 files changed, 32 insertions, 0 deletions
diff --git a/libmariadb/man/mariadb_dyncol_check.3 b/libmariadb/man/mariadb_dyncol_check.3
new file mode 100644
index 00000000..5b425e31
--- /dev/null
+++ b/libmariadb/man/mariadb_dyncol_check.3
@@ -0,0 +1,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]