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