summaryrefslogtreecommitdiffstats
path: root/libmariadb/man/mysql_hex_string.3
diff options
context:
space:
mode:
Diffstat (limited to 'libmariadb/man/mysql_hex_string.3')
-rw-r--r--libmariadb/man/mysql_hex_string.341
1 files changed, 41 insertions, 0 deletions
diff --git a/libmariadb/man/mysql_hex_string.3 b/libmariadb/man/mysql_hex_string.3
new file mode 100644
index 00000000..da116595
--- /dev/null
+++ b/libmariadb/man/mysql_hex_string.3
@@ -0,0 +1,41 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "mysql_hex_string" "3" "" "Version 3.3.1" "MariaDB Connector/C"
+.hy
+.SS Name
+.PP
+mysql_hex_string \- create a hexadecimal string
+.SS Synopsis
+.IP
+.nf
+\f[C]
+#include <mysql.h>
+unsigned long mysql_hex_string(char * to,
+ const char * from,
+ unsigned long len);
+\f[R]
+.fi
+.SS Description
+.PP
+This function is used to create a hexadecimal string which can be used
+in SQL statements.
+e.g.\ \f[C]INSERT INTO my_blob VALUES(X\[aq]A0E1CD\[aq])\f[R].
+.SS Parameter
+.IP \[bu] 2
+\f[C]to\f[R] \- result buffer
+.IP \[bu] 2
+\f[C]from\f[R] \- the string which will be encoded
+.IP \[bu] 2
+\f[C]len\f[R] \- length of the string (from)
+.SS Notes
+.IP \[bu] 2
+The size of the buffer for the encoded string must be 2 * length + 1.
+.IP \[bu] 2
+The encoded string does not contain a leading X\[cq].
+.SS Return value
+.PP
+Returns the length of the encoded string without the trailing null
+character.
+.SS See also
+.IP \[bu] 2
+\f[B]mysql_real_escape_string(3)\f[R]