<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.mysqli-stmt.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'mysqli-stmt.result-metadata.php',
    1 => 'mysqli_stmt::result_metadata',
    2 => 'プリペアドステートメントから結果セットのメタデータを返す',
  ),
  'up' => 
  array (
    0 => 'class.mysqli-stmt.php',
    1 => 'mysqli_stmt',
  ),
  'prev' => 
  array (
    0 => 'mysqli-stmt.reset.php',
    1 => 'mysqli_stmt::reset',
  ),
  'next' => 
  array (
    0 => 'mysqli-stmt.send-long-data.php',
    1 => 'mysqli_stmt::send_long_data',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/mysqli/mysqli_stmt/result-metadata.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="mysqli-stmt.result-metadata" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">mysqli_stmt::result_metadata</h1>
  <h1 class="refname">mysqli_stmt_result_metadata</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">mysqli_stmt::result_metadata</span> -- <span class="refname">mysqli_stmt_result_metadata</span> &mdash; <span class="dc-title">プリペアドステートメントから結果セットのメタデータを返す</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mysqli-stmt.result-metadata-description">
  <h3 class="title">説明</h3>
  <p class="para">オブジェクト指向型</p>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>mysqli_stmt::result_metadata</strong></span>(): <span class="type"><span class="type"><a href="class.mysqli-result.php" class="type mysqli_result">mysqli_result</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">手続き型</p>
  <div class="methodsynopsis dc-description"><span class="methodname"><strong>mysqli_stmt_result_metadata</strong></span>(<span class="methodparam"><span class="type"><a href="class.mysqli-stmt.php" class="type mysqli_stmt">mysqli_stmt</a></span> <code class="parameter">$statement</code></span>): <span class="type"><span class="type"><a href="class.mysqli-result.php" class="type mysqli_result">mysqli_result</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><a href="mysqli.prepare.php" class="function">mysqli_prepare()</a></span> に渡したステートメントが
   結果セットを返すものであった場合、
   <span class="function"><strong>mysqli_stmt_result_metadata()</strong></span>
   はオブジェクトを返します。このオブジェクトは、結果のフィールド数や
   各フィールドの情報などのメタ情報を取得するために使用可能です。
  </p>
  <p class="simpara">
   この関数は空の <span class="classname"><a href="class.mysqli-result.php" class="classname">mysqli_result</a></span> オブジェクトを返します。
   これにより、実際のデータ行を取得せずに、
   プリペアドステートメントからメタデータ情報にアクセスできます。
   <span class="function"><a href="mysqli-stmt.get-result.php" class="function">mysqli_stmt_get_result()</a></span> を使用して、
   プリペアドステートメントから結果オブジェクトとして結果セット全体を取得する場合、
   この関数を使用する必要はありません。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    この結果セットは、
    結果セットのメタデータをフィールドベースで処理する関数にのみ渡せます。
    渡せる関数の例として、以下が挙げられます:
    <ul class="itemizedlist">
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli-result.field-count.php" class="function">mysqli_num_fields()</a></span></p></li>
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli-result.fetch-field.php" class="function">mysqli_fetch_field()</a></span></p></li>
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli-result.fetch-field-direct.php" class="function">mysqli_fetch_field_direct()</a></span></p></li>
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli-result.fetch-fields.php" class="function">mysqli_fetch_fields()</a></span></p></li>
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli.field-count.php" class="function">mysqli_field_count()</a></span></p></li>
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli-result.field-seek.php" class="function">mysqli_field_seek()</a></span></p></li>
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli-result.current-field.php" class="function">mysqli_field_tell()</a></span></p></li>
     <li class="listitem"><p class="para"><span class="function"><a href="mysqli-result.free.php" class="function">mysqli_free_result()</a></span></p></li>
    </ul>
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
    <span class="function"><strong>mysqli_stmt_result_metadata()</strong></span> が返す結果セットには
    メタデータのみが含まれています。実際の行データは含まれません。
    行データを取得するには、ステートメントハンドルを
    <span class="function"><a href="mysqli-stmt.get-result.php" class="function">mysqli_stmt_get_result()</a></span> または、
    <span class="function"><a href="mysqli-stmt.fetch.php" class="function">mysqli_stmt_fetch()</a></span> に渡してください。
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-mysqli-stmt.result-metadata-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    <dt><code class="parameter">stmt</code></dt><dd><p class="para">手続き型のみ:
<span class="function"><a href="mysqli.stmt-init.php" class="function">mysqli_stmt_init()</a></span> が返す <span class="classname"><a href="class.mysqli-stmt.php" class="classname">mysqli_stmt</a></span> オブジェクト。</p></dd>
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-mysqli-stmt.result-metadata-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   結果のオブジェクトを返します。エラー時には <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-mysqli-stmt.result-metadata-errors">
  <h3 class="title">エラー / 例外</h3>
  <p class="para">
mysqli のエラー報告 (<strong><code><a href="mysqli.constants.php#constant.mysqli-report-error">MYSQLI_REPORT_ERROR</a></code></strong>) が有効になっており、かつ要求された操作が失敗した場合は、警告が発生します。さらに、エラー報告のモードが <strong><code><a href="mysqli.constants.php#constant.mysqli-report-strict">MYSQLI_REPORT_STRICT</a></code></strong> に設定されていた場合は、<span class="classname"><a href="class.mysqli-sql-exception.php" class="classname">mysqli_sql_exception</a></span> が代わりにスローされます。</p>
 </div>


 <div class="refsect1 examples" id="refsect1-mysqli-stmt.result-metadata-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 オブジェクト指向型</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$mysqli </span><span style="color: #007700">= new </span><span style="color: #0000BB">mysqli</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP TABLE IF EXISTS friends"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE TABLE friends (id int, name varchar(20))"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">"INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">$mysqli</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">prepare</span><span style="color: #007700">(</span><span style="color: #DD0000">"SELECT id, name FROM friends"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* メタデータの結果セットを取得します */<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$stmt</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">result_metadata</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">/* メタデータ結果セットからフィールド情報を取得します */<br /></span><span style="color: #0000BB">$field </span><span style="color: #007700">= </span><span style="color: #0000BB">$result</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">fetch_field</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Fieldname: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">name</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>例2 手続き型</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$link </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_user"</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_password"</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">mysqli_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">"DROP TABLE IF EXISTS friends"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mysqli_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">"CREATE TABLE friends (id int, name varchar(20))"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">mysqli_query</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">"INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT id, name FROM friends"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">mysqli_stmt_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* メタデータの結果セットを取得します */<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_stmt_result_metadata</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* メタデータ結果セットからフィールド情報を取得します */<br /></span><span style="color: #0000BB">$field </span><span style="color: #007700">= </span><span style="color: #0000BB">mysqli_fetch_field</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Fieldname: %s\n"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">name</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-mysqli-stmt.result-metadata-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="mysqli.prepare.php" class="function" rel="rdfs-seeAlso">mysqli_prepare()</a> - 実行するための SQL文 を準備する</span></li>
    <li><span class="function"><a href="mysqli-result.free.php" class="function" rel="rdfs-seeAlso">mysqli_free_result()</a> - 結果に関連付けられたメモリを開放する</span></li>
    <li><span class="function"><a href="mysqli-stmt.get-result.php" class="function" rel="rdfs-seeAlso">mysqli_stmt_get_result()</a> - プリペアドステートメントから結果を mysqli_result オブジェクトとして取得する</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>