<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.mysql.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.mysql-fetch-field.php',
    1 => 'mysql_fetch_field',
    2 => '結果からカラム情報を取得し、オブジェクトとして返す',
  ),
  'up' => 
  array (
    0 => 'ref.mysql.php',
    1 => 'MySQL 関数',
  ),
  'prev' => 
  array (
    0 => 'function.mysql-fetch-assoc.php',
    1 => 'mysql_fetch_assoc',
  ),
  'next' => 
  array (
    0 => 'function.mysql-fetch-lengths.php',
    1 => 'mysql_fetch_lengths',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/mysql/functions/mysql-fetch-field.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.mysql-fetch-field" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">mysql_fetch_field</h1>
  <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">mysql_fetch_field</span> &mdash; <span class="dc-title">結果からカラム情報を取得し、オブジェクトとして返す</span></p>

 </div>

 <div id="function.mysql-fetch-field-refsynopsisdiv">
  <div class="warning"><strong class="warning">警告</strong>
   <p class="para">
この拡張モジュールは PHP 5.5.0 で非推奨になり、PHP 7.0.0 で削除されました。
<a href="book.mysqli.php" class="link">MySQLi</a> あるいは
<a href="ref.pdo-mysql.php" class="link">PDO_MySQL</a> を使うべきです。詳細な情報は
<a href="mysqlinfo.api.choosing.php" class="link">MySQL: API の選択</a> を参照ください。
この関数の代替として、これらが使えます。</p>
   <ul class="simplelist">
    <li><span class="function"><a href="mysqli-result.fetch-field.php" class="function">mysqli_fetch_field()</a></span></li>
    <li><span class="methodname"><a href="pdostatement.getcolumnmeta.php" class="methodname">PDOStatement::getColumnMeta()</a></span></li>
   </ul>
  </div>
 </div>

 <div class="refsect1 description" id="refsect1-function.mysql-fetch-field-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>mysql_fetch_field</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$result</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$field_offset</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.object.php" class="type object">object</a></span></div>

  <p class="simpara">
   フィールド情報を含むオブジェクトを返します。特定のクエリー結果の中の
   フィールドに関する情報を得るために使用可能です。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.mysql-fetch-field-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   <dt><code class="parameter">result</code></dt><dd><p class="para">評価された結果を示す <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>。この結果は、<span class="function"><a href="function.mysql-query.php" class="function">mysql_query()</a></span> のコールにより得られたものです。</p></dd>
   
    <dt><code class="parameter">field_offset</code></dt>
    <dd>
     <span class="simpara">
      数字で表したフィールドの位置です。もし指定されなければ、
      まだこの関数で情報を取得していないフィールドのうち最初のものが
      選択されます。<code class="parameter">field_offset</code> は、
      <code class="literal">0</code> からはじまります。
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.mysql-fetch-field-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   フィールド情報を含む<span class="type"><a href="language.types.object.php" class="type object">object</a></span>を返します。オブジェクトの
   プロパティは次のとおりです。
  </p>
  <ul class="itemizedlist">
   <li class="listitem">
    <span class="simpara">
     name - カラム名
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     table - カラムが属しているテーブルの名前。エイリアスを定義している場合はエイリアスの名前
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     max_length - カラムの最大長
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     not_null - カラムが <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> 値をとることができない場合 1
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     primary_key - カラムが主キーであれば 1
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     unique_key - カラムがユニークキーであれば 1
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     multiple_key - カラムが非ユニークキーであれば 1
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     numeric - カラムが数値(numeric)であれば 1
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     blob - カラムがBLOBであれば 1
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     type - カラムの型
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     unsigned - カラムが符号無し(unsigned)であれば 1
    </span>
   </li>
   <li class="listitem">
    <span class="simpara">
     zerofill - カラムがゼロで埋められている(zero-filled)場合に 1
    </span>
   </li>
  </ul>
 </div>


 <div class="refsect1 examples" id="refsect1-function.mysql-fetch-field-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 <span class="function"><strong>mysql_fetch_field()</strong></span> の例</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_user'</span><span style="color: #007700">, </span><span style="color: #DD0000">'mysql_password'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$conn</span><span style="color: #007700">) {<br />    die(</span><span style="color: #DD0000">'Could not connect: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mysql_error</span><span style="color: #007700">());<br />}<br /></span><span style="color: #0000BB">mysql_select_db</span><span style="color: #007700">(</span><span style="color: #DD0000">'database'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_query</span><span style="color: #007700">(</span><span style="color: #DD0000">'select * from table'</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$result</span><span style="color: #007700">) {<br />    die(</span><span style="color: #DD0000">'Query failed: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">mysql_error</span><span style="color: #007700">());<br />}<br /></span><span style="color: #FF8000">/* カラムのメタデータを取得する */<br /></span><span style="color: #0000BB">$i </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br />while (</span><span style="color: #0000BB">$i </span><span style="color: #007700">&lt; </span><span style="color: #0000BB">mysql_num_fields</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">"Information for column </span><span style="color: #0000BB">$i</span><span style="color: #DD0000">:&lt;br /&gt;\n"</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$meta </span><span style="color: #007700">= </span><span style="color: #0000BB">mysql_fetch_field</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">$i</span><span style="color: #007700">);<br />    if (!</span><span style="color: #0000BB">$meta</span><span style="color: #007700">) {<br />        echo </span><span style="color: #DD0000">"No information available&lt;br /&gt;\n"</span><span style="color: #007700">;<br />    }<br />    echo </span><span style="color: #DD0000">"&lt;pre&gt;<br />blob:         </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">blob</span><span style="color: #DD0000"><br />max_length:   </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">max_length</span><span style="color: #DD0000"><br />multiple_key: </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">multiple_key</span><span style="color: #DD0000"><br />name:         </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">name</span><span style="color: #DD0000"><br />not_null:     </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">not_null</span><span style="color: #DD0000"><br />numeric:      </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">numeric</span><span style="color: #DD0000"><br />primary_key:  </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">primary_key</span><span style="color: #DD0000"><br />table:        </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">table</span><span style="color: #DD0000"><br />type:         </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">type</span><span style="color: #DD0000"><br />unique_key:   </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">unique_key</span><span style="color: #DD0000"><br />unsigned:     </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">unsigned</span><span style="color: #DD0000"><br />zerofill:     </span><span style="color: #0000BB">$meta</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">zerofill</span><span style="color: #DD0000"><br />&lt;/pre&gt;"</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$i</span><span style="color: #007700">++;<br />}<br /></span><span style="color: #0000BB">mysql_free_result</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-function.mysql-fetch-field-notes">
  <h3 class="title">注意</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: <span class="simpara">この関数により返されるフィー
ルド名は <em>大文字小文字を区別</em> します。</span></p></blockquote>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
    SQL クエリでフィールド名やテーブル名のエイリアスを設定している場合は、
    エイリアスを返します。本来の名前を取得するには、
    <span class="methodname"><a href="mysqli-result.fetch-field.php" class="methodname">mysqli_result::fetch_field()</a></span> を使いましょう。
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.mysql-fetch-field-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.mysql-field-seek.php" class="function" rel="rdfs-seeAlso">mysql_field_seek()</a> - 結果ポインタを指定したフィールドオフセットにセットする</span></li>
  </ul>
 </div>

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