fatfs/doc/ja/mkfs.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/mkfs.html">
   8 <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_mkfs</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_mkfs</h2>
  16 <p>論理ドライブ上にFATボリュームを作成(フォーマット)します。</p>
  17 <pre>
  18 FRESULT f_mkfs (
  19   const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] 論理ドライブ番号 */</span>
  20   BYTE  <span class="arg">sfd</span>,         <span class="c">/* [IN] 区画作成方法 */</span>
  21   UINT  <span class="arg">au</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>path</dt>
  30 <dd>フォーマット対象の論理ドライブを示す<a href="filename.html">パス名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。ドライブ番号を含まない場合は、カレント ドライブを意味します。</dd>
  31 <dt>sfd</dt>
  32 <dd>パーテーション形式。(0(FDISK) または 1(SFD))</dd>
  33 <dt>au</dt>
  34 <dd>クラスタ サイズをバイト数またはセクタ数で指定します。値が1～128の範囲場合は、セクタ数を示します。値が<tt>_MIN_SS</tt>以上の場合は、バイト数を示します。無効値(0または2の累乗でない値など)を指定した場合、ボリュームのサイズに応じたデフォルトのクラスタ サイズが自動選択されます。</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#de">FR_DISK_ERR</a>,
  43 <a href="rc.html#nr">FR_NOT_READY</a>,
  44 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  45 <a href="rc.html#ma">FR_MKFS_ABORTED</a>,
  46 <a href="rc.html#ip">FR_INVALID_PARAMETER</a>
  47 </p>
  48 </div>
  49
  50 <div class="para desc">
  51 <h4>説明</h4>
  52 <p>物理ドライブ上にFATボリュームを作成します。FDISK形式が指定された場合は、物理ドライブ全体を占める基本区画(パーテーション)が作成され、その中にFATボリュームが作成されます。SFD形式では、FATボリュームが物理ドライブの先頭セクタからベタで作成されます。</p>
  53 <p>フォーマットする論理ドライブがマルチ パーテーション機能(<tt>_MULTI_PARTITION</tt>)によって特定の区画(1～4)に結び付けられている場合は、その区画の中にFATボリュームが作成されます。<tt class="arg">sfd</tt>は無視され、また対応する物理ドライブはこれに先立ち、<tt>f_fdisk()</tt>または他のツールで適切に区画設定されている必要があります。</p>
  54 <p>パーテーション形式には、FDISK形式とSFD形式の二通りあります。FDISK形式は、ハードディスク、MMC、SDC、CFC、U Diskなどで標準的に使用されます。FDISK形式では一台の物理ドライブ上に一つまたは複数の区画を作成することができます。区画管理情報はMBR(物理ドライブの先頭セクタ)に記録されます。SFD形式は単に何の分割も行わない形式で、ボリュームは物理ドライブの先頭セクタから開始します。SFD形式は、フロッピー ディスク、マイクロドライブ、光学ディスク、およびその他スーパー フロッピー メディアで標準的に使用されています。</p>
  55 <p>FATタイプ(FAT12/FAT16/FAT32)は、そのボリューム上の<em>クラスタ数によってのみ決定</em>される決まり[FAT仕様書より]になっていて、それ以外の要因はありません。したがって、どのFATタイプになるかはボリューム サイズとクラスタ サイズに依存します。クラスタ サイズは大きくするほど性能が上がります。</p>
  56 <p>クラスタ数がFATタイプの境界に近くなるときは、<tt>FR_MKFS_ABORTED</tt>で関数が失敗する可能性があります。</p>
  57 </div>
  58
  59
  60 <div class="para comp">
  61 <h4>対応情報</h4>
  62 <p><tt>_FS_READONLY == 0</tt>で、且つ<tt>_USE_MKFS == 1</tt>のとき使用可能です。</p>
  63 </div>
  64
  65
  66 <div class="para use">
  67 <h4>使用例</h4>
  68 <pre>
  69 <span class="c">/* Format the default drive */</span>
  70 int main (void)
  71 {
  72     FATFS fs;      <span class="c">/* File system object (volume work area) */</span>
  73     FIL fil;       <span class="c">/* File object */</span>
  74     FRESULT res;   <span class="c">/* API result code */</span>
  75     UINT bw;       <span class="c">/* Bytes written */</span>
  76
  77
  78     <span class="c">/* Register work area */</span>
  79     f_mount(&amp;fs, "", 0);
  80
  81     <span class="c">/* Create FAT volume with default cluster size */</span>
  82     res = f_mkfs("", 0, 0);
  83     if (res) ...
  84
  85     <span class="c">/* Create a file as new */</span>
  86     res = f_open(&fil, "hello.txt", FA_CREATE_NEW | FA_WRITE);
  87     if (res) ...
  88
  89     <span class="c">/* Write a message */</span>
  90     f_write(&fil, "Hello, World!\r\n", 15, &bw);
  91     if (bw != 15) ...
  92
  93     <span class="c">/* Close the file */</span>
  94     f_close(&fil);
  95
  96     <span class="c">/* Unregister work area */</span>
  97     f_mount(0, "", 0);
  98
  99 </pre>
 100 </div>
 101
 102
 103 <div class="para ref">
 104 <h4>参照</h4>
 105 <p><tt><a href="filename.html#vol">ボリューム管理</a>, <a href="fdisk.html">f_fdisk</a></tt></p>
 106 </div>
 107
 108
 109 <p class="foot"><a href="../00index_j.html">戻る</a></p>
 110 </body>
 111 </html>