savelij13
3d65978d31
- Supported multiple drive system. - Changed some APIs for multiple drive system. - Added f_mkfs().
133 lines
4.9 KiB
HTML
133 lines
4.9 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>開く(または作成する)ファイルの <a href="filename.html">ファイル名</a>が入った<tt>'\0'</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>構造体を使ってこのファイルを操作できます。</dd>
|
|
<dt>FR_NO_FILE</dt>
|
|
<dd>ファイルが見つからない。</dd>
|
|
<dt>FR_NO_PATH</dt>
|
|
<dd>パスが見つからない。</dd>
|
|
<dt>FR_INVALID_NAME</dt>
|
|
<dd>ファイル名が不正。</dd>
|
|
<dt>FR_INVALID_DRIVE</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_NOT_ENABLED</dt>
|
|
<dd>その論理ドライブにワーク・エリアが割り当てられていない。</dd>
|
|
<dt>FR_NO_FILESYSTEM</dt>
|
|
<dd>ディスク上に有効なFATパーテーションが見つからない。</dd>
|
|
</dl>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>解説</h4>
|
|
<p>作成されたファイル・オブジェクトは、以降そのファイルに対するアクセスに使用します。ファイルを閉じるときは、<a href="close.html">f_close()</a>を使用します。</p>
|
|
<p>ファイル操作関数を使用する前にまず、<a href="mount.html">f_mount()</a>を使ってそれぞれの論理ドライブにワーク・エリア(ファイル・システム・オブジェクト)を与えなければなりません。この初期化の後、その論理ドライブに対して全てのファイル関数が使えるようになります。</p>
|
|
<p>リードオンリー構成では、<tt>FA_WRITE, FA_CREATE_ALWAYS, FA_OPEN_ALWAYS</tt>の各フラグはサポートされません。</p>
|
|
</div>
|
|
|
|
|
|
<div class="para">
|
|
<h4>使用例（ファイル・コピー）</h4>
|
|
<pre>
|
|
void main ()
|
|
{
|
|
FATFS fs; // 論理ドライブのワーク・エリア(ファイル・システム・オブジェクト)
|
|
FIL fsrc, fdst; // ファイル・オブジェクト
|
|
BYTE buffer[4096]; // file copy buffer
|
|
FRESULT res; // FatFs function common result code
|
|
WORD br, bw; // File R/W count
|
|
|
|
// ドライブ0にワーク・エリアを与える
|
|
f_mount(0, &fs);
|
|
|
|
// ソース・ファイルを開く
|
|
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);
|
|
|
|
// ワーク・エリアを開放する
|
|
f_mount(0, 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>
|