- 20.9.7 C API Prepared Statement Function Descriptions
- 20.9.7.1 mysql_stmt_affected_rows()
- 20.9.7.2 mysql_stmt_attr_get()
- 20.9.7.3 mysql_stmt_attr_set()
- 20.9.7.4 mysql_stmt_bind_param()
- 20.9.7.5 mysql_stmt_bind_result()
- 20.9.7.6 mysql_stmt_close()
- 20.9.7.7 mysql_stmt_data_seek()
- 20.9.7.8 mysql_stmt_errno()
- 20.9.7.9 mysql_stmt_error()
- 20.9.7.10 mysql_stmt_execute()
- 20.9.7.11 mysql_stmt_fetch()
- 20.9.7.12 mysql_stmt_fetch_column()
- 20.9.7.13 mysql_stmt_field_count()
- 20.9.7.14 mysql_stmt_free_result()
- 20.9.7.15 mysql_stmt_init()
- 20.9.7.16 mysql_stmt_insert_id()
- 20.9.7.17 mysql_stmt_num_rows()
- 20.9.7.18 mysql_stmt_param_count()
- 20.9.7.19 mysql_stmt_param_metadata()
- 20.9.7.20 mysql_stmt_prepare()
- 20.9.7.21 mysql_stmt_reset()
- 20.9.7.22 mysql_stmt_result_metadata()
- 20.9.7.23 mysql_stmt_row_seek()
- 20.9.7.24 mysql_stmt_row_tell()
- 20.9.7.25 mysql_stmt_send_long_data()
- 20.9.7.26 mysql_stmt_sqlstate()
- 20.9.7.27 mysql_stmt_store_result()
MYSQL_RES *mysql_stmt_result_metadata(MYSQL_STMT
*stmt)
Description
If a statement passed to
mysql_stmt_prepare() is one that
produces a result set,
mysql_stmt_result_metadata()
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:
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_stmt_result_metadata()
contains only metadata. It does not contain any row results. The
rows are obtained by using the statement handle with
mysql_stmt_fetch().
Return Values
A MYSQL_RES result structure.
NULL if no meta information exists for the
prepared query.
Errors
-
Out of memory.
-
An unknown error occurred.
Example
For the usage of
mysql_stmt_result_metadata(),
refer to the Example from Section 20.9.7.11, “mysql_stmt_fetch()”.
User Comments
Add your own comment.