23.8.11.23 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

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

例

セクション23.8.11.11「mysql_stmt_fetch()」の例を参照してください。