unsigned long mysql_real_escape_string(MYSQL *mysql, char *to, const char *from, unsigned long length)
注意,mysql必須是有效的開放式連接。之所以需要它是因為,轉義功能取決于服務器使用的字符集。
描述
該函數用于創建可在SQL語句中使用的合法SQL字符串。請參見9.1.1節,“字符串”。
按照連接的當前字符集,將“from”中的字符串編碼為轉義SQL字符串。將結果置于“to”中,并添加1個終結用NULL字節。編碼的字符為NUL (ASCII 0)、‘\\n’、‘\\r’、‘\\’、‘'’、‘"’、以及Control-Z(請參見9.1節,“文字值”)。(嚴格地講,MySQL僅需要反斜杠和引號字符,用于引用轉義查詢中的字符串。該函數能引用其他字符,從而使得它們在日志文件中具有更好的可讀性)。
“from”指向的字符串必須是長度字節“long”。必須為“to”緩沖區分配至少length*2+1字節。在最壞的情況下,每個字符或許需要使用2個字節進行編碼,而且還需要終結Null字節。當mysql_real_escape_string()返回時,“to”的內容是由Null終結的字符串。返回值是編碼字符串的長度,不包括終結用Null字符。
如果需要更改連接的字符集,應使用mysql_set_character_set()函數,而不是執行SET NAMES (或SET CHARACTER SET)語句。mysql_set_character_set()的工作方式類似于SET NAMES,但它還能影響mysql_real_escape_string()所使用的字符集,而SET NAMES則不能。
示例:
char query[1000],*end;
end = strmov(query,"INSERT INTO test_table values(");
*end++ = '\\'';
end += mysql_real_escape_string(&mysql, end,"What's this",11);
*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));
}
該示例中使用的strmov()函數包含在mysqlclient庫中,工作方式與strcpy()類似,但會返回指向第1個參數終結用Null的指針。
返回值
置于“to”中的值的長度,不包括終結用Null字符。
錯誤
無。