fatfs/doc/ja/open.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/open.html">
   8 <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_open</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_open</h2>
  16 <p>ファイルをオープンまたは作成します。</p>
  17 <pre>
  18 FRESULT f_open (
  19   FIL* <span class="arg">fp</span>,           <span class="c">/* [OUT] 空のファイル オブジェクト構造体へのポインタ */</span>
  20   const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] ファイル名へのポインタ */</span>
  21   BYTE <span class="arg">mode</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>fp</dt>
  30 <dd>新しく作成するファイル オブジェクト構造体へのポインタを指定します。以降、そのファイルを閉じるまでこのファイル オブジェクトを使用してファイル操作をします。</dd>
  31 <dt>path</dt>
  32 <dd>開くファイルの<a href="filename.html">ファイル名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。</dd>
  33 <dt>mode</dt>
  34 <dd>ファイルのアクセス方法やオープン方法を決めるフラグです。このパラメータには次の組み合わせを指定します。<br>
  35 <table class="lst">
  36 <tr><th>値</th><th>意味</th></tr>
  37 <tr><td>FA_READ</td><td>読み出しモードで開きます。読み書きする場合は<tt>FA_WRITE</tt>と共に指定します。</td></tr>
  38 <tr><td>FA_WRITE</td><td>書き込みモードで開きます。読み書きする場合は<tt>FA_READ</tt>と共に指定します。</td></tr>
  39 <tr><td>FA_OPEN_EXISTING</td><td>既存のファイルを開きます。ファイルが無いときはエラーになります。(デフォルト)</td></tr>
  40 <tr><td>FA_OPEN_ALWAYS</td><td>既存のファイルを開きます。ファイルが無いときはファイルを作成します。追記の場合は、この方法でオープンした後、<a href="lseek.html"><tt>f_lseek()</tt></a>でファイルの最後尾に移動してください。</td></tr>
  41 <tr><td>FA_CREATE_NEW</td><td>ファイルを作成します。同名のファイルがある場合は、<tt>FR_EXIST</tt>で失敗します。</td></tr>
  42 <tr><td>FA_CREATE_ALWAYS</td><td>ファイルを作成します。同名のファイルがある場合は、サイズを0にしてから開きます。</td></tr>
  43 </table>
  44 </dd>
  45 </dl>
  46 </div>
  47
  48
  49 <div class="para ret">
  50 <h4>戻り値</h4>
  51 <p>
  52 <a href="rc.html#ok">FR_OK</a>,
  53 <a href="rc.html#de">FR_DISK_ERR</a>,
  54 <a href="rc.html#ie">FR_INT_ERR</a>,
  55 <a href="rc.html#nr">FR_NOT_READY</a>,
  56 <a href="rc.html#ok">FR_NO_FILE</a>,
  57 <a href="rc.html#np">FR_NO_PATH</a>,
  58 <a href="rc.html#in">FR_INVALID_NAME</a>,
  59 <a href="rc.html#de">FR_DENIED</a>,
  60 <a href="rc.html#ex">FR_EXIST</a>,
  61 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  62 <a href="rc.html#wp">FR_WRITE_PROTECTED</a>,
  63 <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  64 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  65 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  66 <a href="rc.html#tm">FR_TIMEOUT</a>,
  67 <a href="rc.html#lo">FR_LOCKED</a>,
  68 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>,
  69 <a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a>
  70 </p>
  71 </div>
  72
  73
  74 <div class="para desc">
  75 <h4>解説</h4>
  76 <p>既存のファイルを開いたり、新しいファイルを作成します。関数が成功するとファイル オブジェクトが作成され、以降そのファイルに対するアクセスに使用します。ファイルを閉じるときは、<a href="close.html"><tt>f_close()</tt></a>を使用します。何らかの変更が行われたファイルがその後正しく閉じられなかった場合、そのファイルが破損する場合があります。</p>
  77 <p>既に開かれているファイルを開く必要がある場合は、<a href="appnote.html#dup">多重アクセス制御</a>を参照してください。しかし、一つのファイルに対する書き込みモードを含む重複オープンは常に禁止です。</p>
  78 <p>ファイル アクセスを開始する前に、<a href="mount.html"><tt>f_mount()</tt></a>を使ってそれぞれの論理ドライブにワーク エリア(ファイル システム オブジェクト)を与える必要があります。この初期化の後、その論理ドライブに対して全てのファイル関数が使えるようになります。</p>
  79 </div>
  80
  81
  82 <div class="para comp">
  83 <h4>対応情報</h4>
  84 <p>全ての構成で使用可能です。<tt>_FS_READONLY == 1</tt>のときは、<tt>FA_WRITE, FA_CREATE_ALWAYS, FA_CREATE_NEW, FA_OPEN_ALWAYS</tt>の各フラグはサポートされません。</p>
  85 </div>
  86
  87
  88 <div class="para use">
  89 <h4>使用例</h4>
  90 <pre>
  91 <span class="c">/* テキストファイルを読み出して表示 */</span>
  92
  93 FATFS FatFs;   <span class="c">/* 論理ドライブのワーク エリア(ファイル システム オブジェクト) */</span>
  94
  95 int main (void)
  96 {
  97     FIL fil;       <span class="c">/* ファイル オブジェクト */</span>
  98     char line[82]; <span class="c">/* 行バッファ */</span>
  99     FRESULT fr;    <span class="c">/* 戻り値 */</span>
 100
 101
 102     <span class="c">/* デフォルト ドライブにワークエリアを与える */</span>
 103     f_mount(&amp;FatFs, "", 0);
 104
 105     <span class="c">/* テキスト ファイルを開く */</span>
 106     fr = f_open(&amp;fil, "message.txt", FA_READ);
 107     if (fr) return (int)fr;
 108
 109     <span class="c">/* 1行ずつ読み出して表示 */</span>
 110     while (f_gets(line, sizeof line, &amp;fil))
 111         printf(line);
 112
 113     <span class="c">/* ファイルを閉じる */</span>
 114     f_close(&amp;fil);
 115
 116     return 0;
 117 }
 118 </pre>
 119 <pre>
 120 <span class="c">/* ドライブ1のファイル "file.bin" をドライブ0へコピー */</span>
 121
 122 int main (void)
 123 {
 124     FATFS fs[2];         <span class="c">/* 論理ドライブのワークエリア(ファイル システム オブジェクト) */</span>
 125     FIL fsrc, fdst;      <span class="c">/* ファイル オブジェクト */</span>
 126     BYTE buffer[4096];   <span class="c">/* File copy buffer */</span>
 127     FRESULT fr;          <span class="c">/* FatFs function common result code */</span>
 128     UINT br, bw;         <span class="c">/* File R/W count */</span>
 129
 130     <span class="c">/* ドライブ0,1にワーク エリアを与える */</span>
 131     f_mount(&amp;fs[0], "0:", 0);
 132     f_mount(&amp;fs[1], "1:", 0);
 133
 134     <span class="c">/* ドライブ1のコピー元ファイルを開く */</span>
 135     res = f_open(&amp;fsrc, "1:file.dat", FA_OPEN_EXISTING | FA_READ);
 136     if (fr) return (int)fr;
 137
 138     <span class="c">/* ドライブ0にコピー先ファイルを作成する */</span>
 139     res = f_open(&amp;fdst, "0:file.dat", FA_CREATE_ALWAYS | FA_WRITE);
 140     if (fr) return (int)fr;
 141
 142     <span class="c">/* コピー元からコピー先にデータ転送する */</span>
 143     for (;;) {
 144         res = f_read(&amp;fsrc, buffer, sizeof buffer, &amp;br); <span class="c">/* コピー元からから読み出す */</span>
 145         if (res || br == 0) break;   <span class="c">/* エラーかファイル終端 */</span>
 146         res = f_write(&amp;fdst, buffer, br, &amp;bw);           <span class="c">/* それをコピー先に書き込む */</span>
 147         if (res || bw &lt; br) break;   <span class="c">/* エラーかディスク満杯 */</span>
 148     }
 149
 150     <span class="c">/* 全てのファイルを閉じる */</span>
 151     f_close(&amp;fsrc);
 152     f_close(&amp;fdst);
 153
 154     <span class="c">/* ワーク エリアを開放する */</span>
 155     f_mount(NULL, "0:", 0);
 156     f_mount(NULL, "1:", 0);
 157
 158     return (int)fr;
 159 }
 160 </pre>
 161 </div>
 162
 163
 164 <div class="para ref">
 165 <h4>参照</h4>
 166 <p><tt><a href="read.html">f_read</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a>, <a href="sfatfs.html">FATFS</a></tt></p>
 167 </div>
 168
 169 <p class="foot"><a href="../00index_j.html">戻る</a></p>
 170 </body>
 171 </html>