fatfs/doc/ja/mount.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html lang="ja">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   5 <meta http-equiv="Content-Style-Type" content="text/css">
   6 <link rel="up" title="FatFs" href="../00index_j.html">
   7 <link rel="alternate" hreflang="en" title="English" href="../en/mount.html">
   8 <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_mount</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_mount</h2>
  16 <p>論理ドライブにファイル システム オブジェクトを登録・抹消します。</p>
  17 <pre>
  18 FRESULT f_mount (
  19   FATFS*       <span class="arg">fs</span>,     <span class="c">/* [IN] ファイル システム オブジェクト */</span>
  20   const TCHAR* <span class="arg">path</span>,   <span class="c">/* [IN] 論理ドライブ番号 */</span>
  21   BYTE         <span class="arg">opt</span>     <span class="c">/* [IN] 動作オプション */</span>
  22 );
  23 </pre>
  24 </div>
  25
  26 <div class="para arg">
  27 <h4>引数</h4>
  28 <dl class="par">
  29 <dt>fs</dt>
  30 <dd>登録するファイル システム オブジェクトへのポインタ、またはヌル ポインタ</dd>
  31 <dt>path</dt>
  32 <dd>対象となる論理ドライブの<a href="filename.html">パス名</a>を示すヌル文字'\0'終端の文字列へのポインタを指定します。パス名にドライブ番号が含まれない場合は、デフォルト ドライブを指定したことになります。</dd>
  33 <dt>opt</dt>
  34 <dd>ファイル システム オブジェクトの登録と同時にマウント動作を行うかどうかを指定するフラグ。登録抹消のときは意味を持ちません。</dd>
  35 </dl>
  36 </div>
  37
  38 <div class="para ret">
  39 <h4>戻り値</h4>
  40 <p>
  41 <a href="rc.html#ok">FR_OK</a>,
  42 <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  43 <a href="rc.html#de">FR_DISK_ERR</a>,
  44 <a href="rc.html#nr">FR_NOT_READY</a>,
  45 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>
  46 </p>
  47 </div>
  48
  49
  50 <div class="para desc">
  51 <h4>解説</h4>
  52 <p>FatFsモジュールでは、それぞれの論理ドライブに<em>ファイル システム オブジェクト</em>というワーク エリアが必要です。この関数は論理ドライブにファイル システム オブジェクトを登録したり抹消したりします。何らかのファイル関数を使用する前に、この関数でその論理ドライブのファイル システム オブジェクトを与えておかなければなりません。<tt class="arg">fs</tt>にヌル ポインタを指定すると、その論理ドライブのファイル システム オブジェクトの登録は抹消されるだけです。登録抹消されたファイル システム オブジェクトのメモリは解放できます。操作の対象の論理ドライブ上に開かれたままのファイルやディレクトリがあった場合、それらに対して作成された構造体は全て無効になります。この関数の内部処理は次のような順に行われます。</p>
  53 <ol>
  54 <li>対象の論理ドライブを<tt class="arg">path</tt>から得る。</li>
  55 <li>登録されているファイル システム オブジェクトがあるときは、それをクリア(無効化)し、登録を解除する。</li>
  56 <li><tt class="arg">fs</tt>が有効なポインタのときは、そのファイル システム オブジェクトをクリアし、登録する。</li>
  57 <li>マウント動作が指定されているときは、それを実行する。</li>
  58 </ol>
  59 <p><tt class="arg">opt</tt>に0を指定すると、マウント動作(物理ドライブの初期化、FATボリュームの検索、BPBを解析しファイル システム オブジェクトを初期化)は行われず、関数は物理ドライブの状態に関わらず常に成功します。関数内では下位レイヤへのアクセスは発生せず、指定されたファイル システム オブジェクトをクリア(無効化)し、そのアドレスを内部配列に登録するだけです。単に登録済みのファイル システム オブジェクトをクリアする目的にも使えます。実際のマウント動作は、ボリュームへのアクセス(パス名を渡すもの全て)が行われたときに、次のうちいずれかの条件が真の場合に行われます。</p>
  60 <ul>
  61 <li>ファイル システム オブジェクトがクリア(無効)状態(<tt>f_mount</tt>関数の実行による)</li>
  62 <li>物理ドライブが未初期化状態(システム リセットやメディアの交換による)</li>
  63 </ul>
  64 <p><tt class="arg">opt</tt>に1を指定すると、ファイル システムオブジェクトの登録に続きマウント動作が行われます。メディアが無いなどの理由でマウント動作に失敗すると対応するエラーを返しファイル システム オブジェクトはクリア状態のままになりますが、登録自体は有効なので続いてボリュームへのアクセスがあれば再びマウント動作が実行されます。</p>
  65 <p>下位レイヤの実装上メディア交換の検出がサポートされない(<tt>disk_status</tt>関数に反映されない)ときは、アプリケーションはメディア交換の後この関数でファイル システム オブジェクトを明示的にクリアし、マウント動作が正常に行えるようにする必要があります。</p>
  66 </div>
  67
  68
  69 <div class="para comp">
  70 <h4>対応情報</h4>
  71 <p>全ての構成で使用可能です。</p>
  72 </div>
  73
  74
  75 <div class="para ref">
  76 <h4>参照</h4>
  77 <p><tt><a href="open.html">f_open</a></tt>, <tt><a href="sfatfs.html">FATFS</a></tt></p>
  78 </div>
  79
  80 <p class="foot"><a href="../00index_j.html">戻る</a></p>
  81 </body>
  82 </html>