mysql_real_escape_string

mysql_real_escape_string encodes a string for safe use in a SQL statement, taking the connection's current character set into account when escaping special characters.

Syntax

unsigned long mysql_real_escape_string(MYSQL * mysql,
                                       char * to,
                                       const char * from,
                                       unsigned long);

Parameters

• mysql - a MySQL handle, which was previously allocated by mysql_init() or mysql_real_connect().

• to - buffer for the encoded string. The size of this buffer must be length * 2 + 1 bytes: in the worst case every character of the from string needs to be escaped. Additionally, a trailing 0 character will be appended.

• from - a string which will be encoded by mysql_real_escape_string().

• long - the length of the from string.

Description

This function is used to create a legal SQL string that you can use in an SQL statement. The given string is encoded to an escaped SQL string, taking into account the current character set of the connection.

Return Value

Returns the length of the encoded (to) string.

See Also

• mysql_escape_string()

• mysql_hex_string()