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