savelij13
f76dc3a97f
- Improved cluster scan algolithm to write files fast. - Fixed f_mkdir() creates incorrect directory on FAT32.
134 lines
5.4 KiB
HTML
134 lines
5.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html lang="ja">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=Shift_JIS">
|
|
<meta http-equiv="Content-Style-Type" content="text/css">
|
|
<link rel="up" title="FatFs" href="../00index_j.html">
|
|
<link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
|
|
<title>FatFs - f_open</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="para">
|
|
<h2>f_open</h2>
|
|
<p>ファイルをオープンまたは作成します。</p>
|
|
<pre>
|
|
FRESULT f_open (
|
|
FIL* <em>FileObject</em>, // 空のファイルオブジェクト構造体へのポインタ
|
|
const char* <em>FileName</em>, // ファイルのフルパス名へのポインタ
|
|
BYTE <em>ModeFlags</em> // モードフラグ
|
|
);
|
|
</pre>
|
|
</div>
|
|
|
|
<div class="para">
|
|
<h4>パラメータ</h4>
|
|
<dl class="par">
|
|
<dt>FileObject</dt>
|
|
<dd>新しく作成するファイルオブジェクト構造体へのポインタを指定します。以降、そのファイルを閉じるまでこのファイルオブジェクトを使用してファイル操作をします。</dd>
|
|
<dt>FileName</dt>
|
|
<dd>作成する (またはオープンする) ファイルのフルパス名が入った<tt>'\0'</tt>で終わる文字列へのポインタを指定します。ディレクトリセパレータには<tt>'/'</tt>を使用します。FatFsモジュールにはカレントディレクトリの概念がないので、パスはルートディレクトリから辿る絶対パスとなります。文字列先頭のスペースはスキップされます。パス先頭の<tt>'/'</tt>はあってもなくてもかまいません。</dd>
|
|
<dt>ModeFlags</dt>
|
|
<dd>ファイルのアクセス方法やオープン方法を決めるフラグです。このパラメータには次の組み合わせを指定します。<br>
|
|
<table class="lst">
|
|
<tr><th>値</th><th>意味</th></td>
|
|
<tr><td>FA_READ</td><td>読み出しモードでオープンします。読み書きする場合は<tt>FA_WRITE</tt>と共に指定します。</td></tr>
|
|
<tr><td>FA_WRITE</td><td>書き込みモードでオープンします。読み書きする場合は<tt>FA_READ</tt>と共に指定します。</td></tr>
|
|
<tr><td>FA_OPEN_EXISTING</td><td>既存のファイルを開きます。ファイルが無いときはエラーになります。</td></tr>
|
|
<tr><td>FA_CREATE_ALWAYS</td><td>ファイルを作成します。既存のファイルがある場合は、サイズを0にしてから開きます。</td></tr>
|
|
<tr><td>FA_OPEN_ALWAYS</td><td>既存のファイルを開きます。ファイルが無いときはファイルを作成します。</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>戻り値</h4>
|
|
<dl class="ret">
|
|
<dt>FR_OK (0)</dt>
|
|
<dd>正常終了。以降、<tt><em>FileObject</em></tt>構造体を使ってこのファイルを操作できます。ファイルを閉じるときは、<tt><a href="close.html">f_close()</a></tt>を使用します。</dd>
|
|
<dt>FR_NO_FILE</dt>
|
|
<dd>ファイルが見つからない。</dd>
|
|
<dt>FR_NO_PATH</dt>
|
|
<dd>パスが見つからない。</dd>
|
|
<dt>FR_INVALID_NAME</dt>
|
|
<dd>ファイル名が不正。</dd>
|
|
<dt>FR_DENIED</dt>
|
|
<dd>アクセスが拒否された。リードオンリーファイルの書き込みモードオープン、同名のディレクトリまたはリードオンリファイルがある状態でのファイル作成、ディスクまたはディレクトリテーブルが満杯でファイルを作成できないなど。</dd>
|
|
<dt>FR_NOT_READY</dt>
|
|
<dd>メディアがセットされていないなど、ディスクドライブが動作不能状態。</dd>
|
|
<dt>FR_WRITE_PROTECTED</dt>
|
|
<dd>メディアが書き込み禁止状態で書き込みオープンまたはファイル作成をした。</dd>
|
|
<dt>FR_RW_ERROR</dt>
|
|
<dd>ディスクアクセスでエラーが発生した。</dd>
|
|
<dt>FR_INCORRECT_DISK_CHANGE</dt>
|
|
<dd>不正なメディアの取り外しがあった。ファイルを開いたままのメディア交換など。</dd>
|
|
<dt>FR_NOT_ENABLED</dt>
|
|
<dd>FatFsモジュールが停止状態。</dd>
|
|
<dt>FR_NO_FILESYSTEM</dt>
|
|
<dd>ディスク上に有効なFATパーテーションが見つからない。</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>解説</h4>
|
|
<p>FatFsモジュールの使用を開始するにはまず、FatFsモジュールのグローバル変数<em>FatFs</em>にゼロクリアしたワークエリア(<tt>FATFS</tt>構造体)のアドレスを代入します。このようにしてFatFsモジュールにワークエリアを割り当てるとモジュールは動作可能状態になり、ファイル関数が使えるようになります。ゼロクリアの代わりに<a href="mountdrv.html">f_mountdrv()</a>でもOKですが、少なくともその時点で物理ドライブが動作可能になっていなければなりません。FatFsモジュールの使用を終了するには、全てのファイルを閉じたあと<em>FatFs</em>をクリアします。その後、ワークエリアは破棄できます。</p>
|
|
<p>リードオンリー構成では、<tt>FA_WRITE, FA_CREATE_ALWAYS, FA_OPEN_ALWAYS</tt>の各フラグはサポートされません。</p>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>使用例（ファイルコピー）</h4>
|
|
<pre>
|
|
void main ()
|
|
{
|
|
FATFS fs; // FatFsワークエリア
|
|
FIL fsrc, fdst; // ファイルオブジェクト
|
|
BYTE buffer[4096]; // file copy buffer
|
|
FRESULT res; // FatFs function common result code
|
|
WORD br, bw; // File R/W count
|
|
|
|
|
|
// FatFsのワークエリアを確保する
|
|
FatFs = &fs;
|
|
memset(&fs, 0, sizeof(FATFS)); // ワークエリアの初期化。代わりに f_mountdrv() でもよい
|
|
|
|
// ソース・ファイルを開く
|
|
res = f_open(&fsrc, "srcfile.dat", FA_OPEN_EXISTING | FA_READ);
|
|
if (res) die(res);
|
|
|
|
// デスティネーション・ファイルを作成する
|
|
res = f_open(&fdst, "dstfile.dat", FA_CREATE_ALWAYS | FA_WRITE);
|
|
if (res) die(res);
|
|
|
|
// ソースからデスティネーションにコピーする
|
|
for (;;) {
|
|
res = f_read(&fsrc, buffer, sizeof(buffer), &br);
|
|
if (res || br == 0) break; // error or eof
|
|
res = f_write(&fdst, buffer, br, &bw);
|
|
if (res || bw < br) break; // error or disk full
|
|
}
|
|
|
|
// 全てのファイルを閉じる
|
|
f_close(&fsrc);
|
|
f_close(&fdst);
|
|
|
|
// FatFsのワークエリアを開放する
|
|
FatFs = NULL;
|
|
}
|
|
</pre>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>参照</h4>
|
|
<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>
|
|
</div>
|
|
|
|
<p class="foot"><a href="../00index_j.html">戻る</a></p>
|
|
</body>
|
|
</html>
|