fatfs/doc/ja/findfirst.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/findfirst.html">
   8 <link rel="stylesheet" href="../css_j.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_findfirst</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_findfirst</h2>
  16 <p>ディレクトリ内のオブジェクトの検索を開始します。</p>
  17 <pre>
  18 FRESULT f_findfirst (
  19   DIR* <span class="arg">dp</span>,              <span class="c">/* [OUT] ディレクトリ オブジェクト構造体へのポインタ */</span>
  20   FILINFO* <span class="arg">fno</span>,         <span class="c">/* [OUT] ファイル情報構造体へのポインタ */</span>
  21   const TCHAR* <span class="arg">path</span>,    <span class="c">/* [IN] ディレクトリ名へのポインタ */</span>
  22   const TCHAR* <span class="arg">pattern</span>  <span class="c">/* [IN] マッチ パターン文字列へのポインタ */</span>
  23 );
  24 </pre>
  25 </div>
  26
  27 <div class="para arg">
  28 <h4>引数</h4>
  29 <dl class="par">
  30 <dt>dp</dt>
  31 <dd>空のディレクトリ オブジェクト構造体へのポインタを指定します。</dd>
  32 <dt>fno</dt>
  33 <dd>最初にマッチしたディレクトリ項目を格納するファイル情報構造体へのポインタを指定します。</dd>
  34 <dt>path</dt>
  35 <dd>オープンするディレクトリの<a href="filename.html">パス名</a>を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。</dd>
  36 <dt>pattern</dt>
  37 <dd>検索する名前を示すヌル文字<tt>'\0'</tt>終端の文字列へのポインタを指定します。この文字列は、続く<tt>f_findnext</tt>関数でも参照されるため、一連の処理が終了するまで有効でなければなりません。</dd>
  38 </dl>
  39 </div>
  40
  41
  42 <div class="para ret">
  43 <h4>戻り値</h4>
  44 <p>
  45 <a href="rc.html#ok">FR_OK</a>,
  46 <a href="rc.html#de">FR_DISK_ERR</a>,
  47 <a href="rc.html#ie">FR_INT_ERR</a>,
  48 <a href="rc.html#nr">FR_NOT_READY</a>,
  49 <a href="rc.html#np">FR_NO_PATH</a>,
  50 <a href="rc.html#in">FR_INVALID_NAME</a>,
  51 <a href="rc.html#io">FR_INVALID_OBJECT</a>,
  52 <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  53 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  54 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  55 <a href="rc.html#tm">FR_TIMEOUT</a>,
  56 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>,
  57 <a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a>
  58 </p>
  59 </div>
  60
  61
  62 <div class="para desc">
  63 <h4>解説</h4>
  64 <p><tt class="arg">path</tt>で指定されるディレクトリを開き、そのディレクトリ内の項目の検索を開始します。正常終了すると、ディレクトリ オブジェクト構造体が作成され、最初に検索名文字列に名前がマッチした項目の情報が<tt class="arg">fno</tt>の指定するファイル情報構造体にストアされます。名前のマッチする項目が見つからなかった場合は、<tt>fno-&gt;fname[]</tt>にヌル文字列が返されます。ファイル情報構造体の使い方については、<a href="readdir.html"><tt>f_readdir</tt></a>関数を参照してください。</p>
  65 <p>マッチ パターン文字列は、ワイルドカード文字(<tt>?</tt>と<tt>*</tt>)を含むことができます。<tt>?</tt>は任意の1文字に、<tt>*</tt>は0文字以上の任意の文字列にマッチします。LFN構成では、<tt>_USE_FIND = 1</tt>のとき<tt>fname[]</tt>のみテストし、<tt>_USE_FIND = 2</tt>のときは<tt>altname[]</tt>もテストします。現リビジョンではパターン マッチングにおいて次の点で標準システムとは異なる動作となります。</p>
  66 <ul>
  67 <li><tt>"*.*"</tt>は拡張子なしの名前にマッチしない。(標準システムでは全ての名前にマッチ)</li>
  68 <li>ピリオドで終わるパターンは、どの名前にもマッチしない。(標準システムでは拡張子無しの名前にマッチ)</li>
  69 <li><a href="filename.html#case">DBCS拡張文字</a>については、LFN構成でも非Unicode API構成ではケース センシティブとなる。</li>
  70 </ul>
  71 </div>
  72
  73
  74 <div class="para comp">
  75 <h4>対応情報</h4>
  76 <p>この関数は、<a href="opendir.html"><tt>f_opendir</tt></a>関数および<a href="readdir.html"><tt>f_readdir</tt></a>関数のラッパー関数です。<tt>_USE_FIND &gt;= 1</tt>で、かつ<tt>_FS_MINIMIZE &lt;= 1</tt>のとき使用可能になります。</p>
  77 </div>
  78
  79
  80 <div class="para use">
  81 <h4>使用例</h4>
  82 <pre>
  83 <span class="c">/* ディレクトリ内のオブジェクトの検索と表示 */</span>
  84
  85 void find_image (void)
  86 {
  87     FRESULT fr;     <span class="c">/* API戻り値 */</span>
  88     DIR dj;         <span class="c">/* ディレクトリ オブジェクト */</span>
  89     FILINFO fno;    <span class="c">/* ファイル情報 */</span>
  90
  91     fr = f_findfirst(&amp;dj, &amp;fno, "", "dsc*.jpg");  <span class="c">/* "dsc"で始まるJPEGファイルを検索 */</span>
  92
  93     while (fr == FR_OK &amp;&amp; fno.fname[0]) {         <span class="c">/* 見つかる間繰り返し */</span>
  94         printf("%s\n", fno.fname);                <span class="c">/* 見つけた項目の名前を表示 */</span>
  95         fr = f_findnext(&amp;dj, &amp;fno);               <span class="c">/* 次を検索 */</span>
  96     }
  97     f_closedir(&amp;dj);
  98 }
  99 </pre>
 100 </div>
 101
 102
 103 <div class="para ref">
 104 <h4>参照</h4>
 105 <p><tt><a href="findnext.html">f_findnext</a>, <a href="closedir.html">f_closedir</a>, <a href="sdir.html">DIR</a>, <a href="sfileinfo.html">FILINFO</a></tt></p>
 106 </div>
 107
 108 <p class="foot"><a href="../00index_j.html">戻る</a></p>
 109 </body>
 110 </html>