Skip navigation links
11.1.7.4 mysql_bind_param() »
Section Navigation      [Toggle]

11.1.7.3. mysql_get_metadata()

MYSQL_RES *mysql_get_metadata(MYSQL_STMT *stmt)

説明

mysql_prepare() に渡されたステートメントが結果セットを生成するものである場合、mysql_get_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_get_metadata() から返される結果セットには、メタデータだけが含まれます。レコードデータは含まれません。レコードを取得するには、ステートメントハンドルをパラメータとして mysql_fetch() を呼び出します。

戻り値

MYSQL_RES 構造体。プリコンパイルしたクエリのメタ情報が存在しない場合は NULL。

エラー

  • CR_OUT_OF_MEMORY

    メモリが不足していた。

  • CR_UNKNOWN_ERROR

    不明なエラーが発生した。

例

mysql_get_metadata() の使用方法については、項11.1.7.13. 「mysql_fetch()」 の「例」を参照してください。

This is a translation of the MySQL Reference Manual that can be found at dev.mysql.com. The original Reference Manual is in English, and this translation is not necessarily as up to date as the English version.