プリペアドステートメントから結果セットのメタデータを返す

# mysqli_stmt::result_metadata

# mysqli_stmt_result_metadata

(PHP 5, PHP 7)

mysqli_stmt::result_metadata -- mysqli_stmt_result_metadata — プリペアドステートメントから結果セットのメタデータを返す

### 説明

オブジェクト指向型

mysqli_stmt::result_metadata ( void ) : mysqli_result

手続き型

mysqli_stmt_result_metadata ( mysqli_stmt `$stmt` ) : mysqli_result

mysqli_prepare() に渡したステートメントが 結果セットを返すものであった場合、mysqli_stmt_result_metadata() はオブジェクトを返します。このオブジェクトは、結果のフィールド数や 各フィールドの情報などのメタ情報を取得するために使用可能です。

> 注意:

> メタデータを取得するには、この結果セットポインタを、以下のいずれかの (フィールドベースの) 関数に渡します。

> - mysqli_num_fields()

> - mysqli_fetch_field()

> - mysqli_fetch_field_direct()

> - mysqli_fetch_fields()

> - mysqli_field_count()

> - mysqli_field_seek()

> - mysqli_field_tell()

> - mysqli_free_result()

結果セットは、使用終了後に開放すべきです。そのためには、結果セットを mysqli_free_result() に渡します。

> 注意:

> mysqli_stmt_result_metadata() が返す結果セットには メタデータのみが含まれています。実際の行データは含まれません。行データを 取得するには、ステートメントハンドルを mysqli_stmt_fetch() に渡してください。

### パラメータ

`stmt`

  手続き型のみ: mysqli_stmt_init() が返すステートメント ID。

### 返り値

結果のオブジェクトを返します。エラー時には `FALSE` を返します。

### 例

例1 オブジェクト指向型

`<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "test");
$mysqli->query("DROP TABLE IF EXISTS friends");
$mysqli->query("CREATE TABLE friends (id int, name varchar(20))");
$mysqli->query("INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");
$stmt = $mysqli->prepare("SELECT id, name FROM friends");
$stmt->execute();
/* メタデータの結果セットを取得します */
$result = $stmt->result_metadata();
/* メタデータ結果セットからフィールド情報を取得します */
$field = $result->fetch_field();
printf("Fieldname: %s\n", $field->name);
/* 結果セットを閉じます */
$result->close();
/* 接続を閉じます */
$mysqli->close();
?>`

例2 手続き型

`<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "test");
mysqli_query($link, "DROP TABLE IF EXISTS friends");
mysqli_query($link, "CREATE TABLE friends (id int, name varchar(20))");
mysqli_query($link, "INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");
$stmt = mysqli_prepare($link, "SELECT id, name FROM friends");
mysqli_stmt_execute($stmt);
/* メタデータの結果セットを取得します */
$result = mysqli_stmt_result_metadata($stmt);
/* メタデータ結果セットからフィールド情報を取得します */
$field = mysqli_fetch_field($result);
printf("Fieldname: %s\n", $field->name);
/* 結果セットを閉じます */
mysqli_free_result($result);
/* 接続を閉じます */
mysqli_close($link);
?>`

### 参考

- mysqli_prepare() - 実行するための SQL ステートメントを準備する
- mysqli_free_result() - 結果に関連付けられたメモリを開放する