MySQL Manual
9 MySQL APIs
- 9.1 MySQL C API
- 9.1.7 C API Prepared Statement Function Descriptions
- 9.1.7.1
mysql_prepare() - 9.1.7.2
mysql_param_count() - 9.1.7.3
mysql_prepare_result() - 9.1.7.4
mysql_bind_param() - 9.1.7.5
mysql_execute() - 9.1.7.6
mysql_stmt_affected_rows() - 9.1.7.7
mysql_bind_result() - 9.1.7.8
mysql_stmt_store_result() - 9.1.7.9
mysql_stmt_data_seek() - 9.1.7.10
mysql_stmt_row_seek() - 9.1.7.11
mysql_stmt_row_tell() - 9.1.7.12
mysql_stmt_num_rows() - 9.1.7.13
mysql_fetch() - 9.1.7.14
mysql_send_long_data() - 9.1.7.15
mysql_stmt_close() - 9.1.7.16
mysql_stmt_errno() - 9.1.7.17
mysql_stmt_error() - 9.1.7.18
mysql_stmt_sqlstate()
- 9.1.7.1
9.1.7.1 mysql_prepare()
MYSQL_STMT * mysql_prepare(MYSQL *mysql, const char *query, unsigned
long length)
Description
Prepares the SQL query pointed to by the null-terminated string
query, and returns a statement handle to be used for further operations
on the statement. The query must consist of a single SQL statement. You should
not add a terminating semicolon (`;') or \g to the statement.
The application can include one or more parameter markers in the SQL statement by embedding question mark (`?') characters into the SQL string at the appropriate positions.
The markers are legal only in certain places in SQL statements. For
example, they are allowed in the VALUES() list of an INSERT
statement (to specify column values for a row), or in a comparison with a
column in a WHERE clause to specify a comparison value.
However, they are not allowed for identifiers (such as table or column
names), in the select list that names the columns to
be returned by a SELECT statement), or to specify both
operands of a binary operator such as the = equal sign.
The latter restriction is necessary because it
would be impossible to determine the parameter type. In general,
parameters are legal only in Data Manipulation Languange (DML)
statements, and not in Data Defination Language (DDL) statements.
The parameter markers must be bound to application variables using
mysql_bind_param() before executing the statement.
Return Values
A pointer to a MYSQL_STMT structure if the prepare was successful.
NULL if an error occurred.
Errors
CR_COMMANDS_OUT_OF_SYNC- Commands were executed in an improper order.
CR_OUT_OF_MEMORY- Out of memory.
CR_SERVER_GONE_ERROR- The MySQL server has gone away.
CR_SERVER_LOST- The connection to the server was lost during the query
CR_UNKNOWN_ERROR- An unknown error occurred.
If the prepare is not successful (that is, mysql_prepare() returns
NULL), the error message can be obtained by calling
mysql_error().
Example
For the usage of mysql_prepare(), refer to the Example from
section 9.1.7.5 mysql_execute().
