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.3 mysql_prepare_result()
MYSQL_RES *mysql_prepare_result(MYSQL_STMT *stmt)
Description
If a statement passed to mysql_prepare() is one that produces a result
set,
mysql_prepare_result() returns the result set metadata in the form of a
pointer to a
MYSQL_RES structure that can be used to process the
meta information such as total number of fields and individual field
information. This result set pointer can be passed as an argument to
any of the field-based API functions that process result set metadata, such
as:
mysql_num_fields()mysql_fetch_field()mysql_fetch_field_direct()mysql_fetch_fields()mysql_field_count()mysql_field_seek()mysql_field_tell()mysql_free_result()
The result set structure should be freed when you are done with it, which
you can do by passing it to mysql_free_result(). This is similar
to the way you free a result set obtained from a call to
mysql_store_result().
The result set returned by mysql_prepare_result() contains only
metadata. It does not contain any row results. The rows are obtained by using
the statement handle with mysql_fetch().
Return Values
A MYSQL_RES result structure. NULL if no meta information exists
for the prepared query.
Errors
CR_OUT_OF_MEMORY- Out of memory.
CR_UNKNOWN_ERROR- An unknown error occurred.
Example
For the usage of mysql_prepare_result(), refer to the Example from
section 9.1.7.13 mysql_fetch().
