Skip navigation links
23.2.7.23 mysql_stmt_row_seek() »
Section Navigation      [Toggle]

23.2.7.22. mysql_stmt_result_metadata()

MYSQL_RES *mysql_stmt_result_metadata(MYSQL_STMT *stmt)

説明

mysql_stmt_prepare()に渡したステートメントが結果セットを生成するものである場合、mysql_stmt_result_metadata()は、ポインターの形の結果セットメタデータを、フィールドの合計ナンバーと個別フィールド情報を処理するのに利用できるMYSQL_RES構造に戻します。この結果セットポインターは引数として、フィールドベースの結果セットメタデータを処理するAPI機能のいずれにも渡すことができます。

  • 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()

結果セット構造はそれが必要なとき、解放されるべきです。解放は、それをmysql_free_result()に渡すことによって実行されます。これは、mysql_store_result()に対する呼び出しから取得した結果セットを解放すると同じ方法です。

mysql_stmt_result_metadata()によって戻された結果セットにはメタデータだけが含まれています。それは列の結果を含んでいません。列は、mysql_stmt_fetch()を含むステートメントハンドルを使うことによって取得することができます。

戻り値

MYSQL_RES結果構造。NULLメタ情報が準備されたクエリーのために存在しない場合。

エラー

  • CR_OUT_OF_MEMORY

    メモリ不足。

  • CR_UNKNOWN_ERROR

    未知のエラーが起こりました。

例

mysql_stmt_result_metadata()の用途については、項23.2.7.11. 「mysql_stmt_fetch()」から例をご参照ください。