]>
Commit | Line | Data |
---|---|---|
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">\r | |
2 | <html lang="en">\r | |
3 | <head>\r | |
4 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8">\r | |
5 | <meta http-equiv="Content-Style-Type" content="text/css">\r | |
6 | <link rel="up" title="FatFs" href="../00index_e.html">\r | |
7 | <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/findfirst.html">\r | |
8 | <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r | |
9 | <title>FatFs - f_findfirst</title>\r | |
10 | </head>\r | |
11 | \r | |
12 | <body>\r | |
13 | \r | |
14 | <div class="para func">\r | |
15 | <h2>f_findfirst</h2>\r | |
16 | <p>The f_findfirst function searches a directroy for an item.</p>\r | |
17 | <pre>\r | |
18 | FRESULT f_findfirst (\r | |
19 | DIR* <span class="arg">dp</span>, <span class="c">/* [OUT] Poninter to the directory object */</span>\r | |
20 | FILINFO* <span class="arg">fno</span>, <span class="c">/* [OUT] Pointer to the file information structure */</span>\r | |
21 | const TCHAR* <span class="arg">path</span>, <span class="c">/* [IN] Pointer to the directory name to be opened */</span>\r | |
22 | const TCHAR* <span class="arg">pattern</span> <span class="c">/* [IN] Pointer to the matching pattern string */</span>\r | |
23 | );\r | |
24 | </pre>\r | |
25 | </div>\r | |
26 | \r | |
27 | <div class="para arg">\r | |
28 | <h4>Parameters</h4>\r | |
29 | <dl class="par">\r | |
30 | <dt>dp</dt>\r | |
31 | <dd>Pointer to the blank directory object.</dd>\r | |
32 | <dt>fno</dt>\r | |
33 | <dd>Pointer to the <a href="sfileinfo.html">file information structure</a> to store the information about the found item.</dd>\r | |
34 | <dt>path</dt>\r | |
35 | <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to be opened.</dd>\r | |
36 | <dt>pattern</dt>\r | |
37 | <dd>Pointer to the nul-terminated string that specifies the name matching pattern to be searched for. It is referred by also subsequent <tt>f_findnext</tt> function, so that the string must be valid while the successive function calls.</dd>\r | |
38 | </dl>\r | |
39 | </div>\r | |
40 | \r | |
41 | \r | |
42 | <div class="para ret">\r | |
43 | <h4>Return Values</h4>\r | |
44 | <p>\r | |
45 | <a href="rc.html#ok">FR_OK</a>,\r | |
46 | <a href="rc.html#de">FR_DISK_ERR</a>,\r | |
47 | <a href="rc.html#ie">FR_INT_ERR</a>,\r | |
48 | <a href="rc.html#nr">FR_NOT_READY</a>,\r | |
49 | <a href="rc.html#np">FR_NO_PATH</a>,\r | |
50 | <a href="rc.html#in">FR_INVALID_NAME</a>,\r | |
51 | <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r | |
52 | <a href="rc.html#id">FR_INVALID_DRIVE</a>,\r | |
53 | <a href="rc.html#ne">FR_NOT_ENABLED</a>,\r | |
54 | <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,\r | |
55 | <a href="rc.html#tm">FR_TIMEOUT</a>,\r | |
56 | <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>,\r | |
57 | <a href="rc.html#tf">FR_TOO_MANY_OPEN_FILES</a>\r | |
58 | </p>\r | |
59 | </div>\r | |
60 | \r | |
61 | \r | |
62 | <div class="para desc">\r | |
63 | <h4>Description</h4>\r | |
64 | <p>After the directory specified by <tt class="arg">path</tt> could be opened, it starts to search the directory for items with the name specified by <tt class="arg">pattern</tt>. If the first item is found, the information about the object is stored into the file information structure <tt class="arg">fno</tt>.</p>\r | |
65 | <p>The matching pattern can contain wildcard characters (<tt>?</tt> and <tt>*</tt>). A <tt>?</tt> matches an any character and an <tt>*</tt> matches an any string in length of zero or longer. When support of long file name is enabled, only <tt>fname[]</tt> is tested at <tt>FF_USE_FIND == 1</tt> and also <tt>altname[]</tt> is tested at <tt>FF_USE_FIND == 2</tt>. In this revision, there are some differences listed below between FatFs and standard systems in matching condition.</p>\r | |
66 | <ul>\r | |
67 | <li><tt>"*.*"</tt> never matches any name without extension while it matches any name with or without extension at the standard systems.</li>\r | |
68 | <li>Any pattern terminated with a period never matches any name while it matches any name without extensiton at the standard systems.</li>\r | |
69 | <li><a href="filename.html#case">DBCS extended characters</a> are compared in case-sensitive at LFN with ANSI/OEM API.</li>\r | |
70 | </ul>\r | |
71 | </div>\r | |
72 | \r | |
73 | \r | |
74 | <div class="para comp">\r | |
75 | <h4>QuickInfo</h4>\r | |
76 | <p>This is a wrapper function of <a href="opendir.html"><tt>f_opendir</tt></a> and <a href="readdir.html"><tt>f_readdir</tt></a> function. Available when <tt><a href="config.html#use_find">FF_USE_FIND</a> >= 1</tt> and <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> <= 1</tt>.</p>\r | |
77 | </div>\r | |
78 | \r | |
79 | \r | |
80 | <div class="para use">\r | |
81 | <h4>Examples</h4>\r | |
82 | <pre>\r | |
83 | <span class="c">/* Search a directory for objects and display it */</span>\r | |
84 | \r | |
85 | void find_image_file (void)\r | |
86 | {\r | |
87 | FRESULT fr; <span class="c">/* Return value */</span>\r | |
88 | DIR dj; <span class="c">/* Directory search object */</span>\r | |
89 | FILINFO fno; <span class="c">/* File information */</span>\r | |
90 | \r | |
91 | fr = <em>f_findfirst</em>(&dj, &fno, "", "dsc*.jpg"); <span class="c">/* Start to search for photo files */</span>\r | |
92 | \r | |
93 | while (fr == FR_OK && fno.fname[0]) { <span class="c">/* Repeat while an item is found */</span>\r | |
94 | printf("%s\n", fno.fname); <span class="c">/* Display the object name */</span>\r | |
95 | fr = f_findnext(&dj, &fno); <span class="c">/* Search for next item */</span>\r | |
96 | }\r | |
97 | \r | |
98 | f_closedir(&dj);\r | |
99 | }\r | |
100 | </pre>\r | |
101 | </div>\r | |
102 | \r | |
103 | \r | |
104 | <div class="para ref">\r | |
105 | <h4>See Also</h4>\r | |
106 | <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>\r | |
107 | </div>\r | |
108 | \r | |
109 | <p class="foot"><a href="../00index_e.html">Return</a></p>\r | |
110 | </body>\r | |
111 | </html>\r |