MySQL 5.6 C API Developer Guide
unsigned long mysql_real_escape_string(MYSQL *mysql, char *to, const char *from, unsigned long length)
This function creates a legal SQL string for use in an SQL statement. See String Literals.
The mysql
argument must be a valid, open
connection because character escaping depends on the character
set in use by the server.
The string in the from
argument is encoded
to produce an escaped SQL string, taking into account the
current character set of the connection. The result is placed
in the to
argument, followed by a
terminating null byte.
Characters encoded are \
,
'
, "
,
NUL
(ASCII 0), \n
,
\r
, and Control+Z. Strictly speaking, MySQL
requires only that backslash and the quote character used to
quote the string in the query be escaped.
mysql_real_escape_string()
quotes the other characters to make them easier to read in log
files. For comparison, see the quoting rules for literal
strings and the QUOTE()
SQL
function in String Literals, and
String Functions and Operators.
The string pointed to by from
must be
length
bytes long. You must allocate the
to
buffer to be at least
length*2+1
bytes long. (In the worst case,
each character may need to be encoded as using two bytes, and
there must be room for the terminating null byte.) When
mysql_real_escape_string()
returns, the contents of to
is a
null-terminated string. The return value is the length of the
encoded string, not including the terminating null byte.
If you must change the character set of the connection, use
the mysql_set_character_set()
function rather than executing a SET
NAMES
(or SET CHARACTER
SET
) statement.
mysql_set_character_set()
works like SET NAMES
but also
affects the character set used by
mysql_real_escape_string()
,
which SET NAMES
does not.
The following example inserts two escaped strings into an
INSERT
statement, each within single quote
characters:
char query[1000],*end; end = strmov(query,"INSERT INTO test_table VALUES("); *end++ = '\''; end += mysql_real_escape_string(&mysql,end,"What is this",12); *end++ = '\''; *end++ = ','; *end++ = '\''; end += mysql_real_escape_string(&mysql,end,"binary data: \0\r\n",16); *end++ = '\''; *end++ = ')'; if (mysql_real_query(&mysql,query,(unsigned int) (end - query))) { fprintf(stderr, "Failed to insert row, Error: %s\n", mysql_error(&mysql)); }
The strmov()
function used in the example
is included in the libmysqlclient
library
and works like strcpy()
but returns a
pointer to the terminating null of the first parameter.
The length of the encoded string that is placed into the
to
argument, not including the terminating
null character.