C API Prepared Statement Function Descriptions
2217
Errors
•
CR_COMMANDS_OUT_OF_SYNC
[2942]
Commands were executed in an improper order.
•
CR_SERVER_GONE_ERROR
[2942]
The MySQL server has gone away.
•
CR_SERVER_LOST
[2942]
The connection to the server was lost during the query
•
CR_UNKNOWN_ERROR
[2941]
An unknown error occurred.
20.6.10.22.
mysql_stmt_result_metadata()
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 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_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
•
CR_OUT_OF_MEMORY
[2942]
Out of memory.
Summary of Contents for 5.0
Page 1: ...MySQL 5 0 Reference Manual ...
Page 18: ...xviii ...
Page 60: ...40 ...
Page 396: ...376 ...
Page 578: ...558 ...
Page 636: ...616 ...
Page 844: ...824 ...
Page 1234: ...1214 ...
Page 1427: ...MySQL Proxy Scripting 1407 ...
Page 1734: ...1714 ...
Page 1752: ...1732 ...
Page 1783: ...Configuring Connector ODBC 1763 ...
Page 1793: ...Connector ODBC Examples 1773 ...
Page 1839: ...Connector Net Installation 1819 2 You must choose the type of installation to perform ...
Page 2850: ...2830 ...
Page 2854: ...2834 ...
Page 2928: ...2908 ...
Page 3000: ...2980 ...
Page 3122: ...3102 ...
Page 3126: ...3106 ...
Page 3174: ...3154 ...
Page 3232: ...3212 ...