(mysql.info) mysql-stmt-result-metadata

Info Catalog

(mysql.info) mysql-stmt-reset

(mysql.info) c-api-prepared-statement-functions

(mysql.info) mysql-stmt-row-seek

 
 22.2.7.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 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_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'
 
      Out of memory.
 
    * `CR_UNKNOWN_ERROR'
 
      An unknown error occurred.
 
 *Example*
 
 For the usage of `mysql_stmt_result_metadata()', refer to the Example
 from  mysql-stmt-fetch.
 

Info Catalog

(mysql.info) mysql-stmt-reset

(mysql.info) c-api-prepared-statement-functions

(mysql.info) mysql-stmt-row-seek