Add test for fatfs.
[bertos.git] / bertos / fs / fatfs / doc / en / mkdir.html
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=iso-8859-1">\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="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">\r
8 <title>FatFs - f_mkdir</title>\r
9 </head>\r
10 \r
11 <body>\r
12 \r
13 <div class="para">\r
14 <h2>f_mkdir</h2>\r
15 <p>The f_mkdir function creates a new directory.</p>\r
16 <pre>\r
17 FRESULT f_mkdir (\r
18   const char* <em>DirName</em> /* Pointer to the directory name */\r
19 );\r
20 </pre>\r
21 </div>\r
22 \r
23 <div class="para">\r
24 <h4>Parameter</h4>\r
25 <dl class="par">\r
26 <dt>DirName</dt>\r
27 <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to create. </dd>\r
28 </dl>\r
29 </div>\r
30 \r
31 \r
32 <div class="para">\r
33 <h4>Return Value</h4>\r
34 <dl class="ret">\r
35 <dt>FR_OK (0)</dt>\r
36 <dd>The function succeeded.</dd>\r
37 <dt>FR_NO_PATH</dt>\r
38 <dd>Could not find the path.</dd>\r
39 <dt>FR_INVALID_NAME</dt>\r
40 <dd>The path name is invalid.</dd>\r
41 <dt>FR_INVALID_DRIVE</dt>\r
42 <dd>The drive number is invalid.</dd>\r
43 <dt>FR_DENIED</dt>\r
44 <dd>The directory cannot be created due to directory table or disk is full.</dd>\r
45 <dt>FR_EXIST</dt>\r
46 <dd>A file or directory that has same name is already existing.</dd>\r
47 <dt>FR_NOT_READY</dt>\r
48 <dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>\r
49 <dt>FR_WRITE_PROTECTED</dt>\r
50 <dd>The medium is write protected.</dd>\r
51 <dt>FR_DISK_ERR</dt>\r
52 <dd>The function failed due to an error in the disk function.</dd>\r
53 <dt>FR_INT_ERR</dt>\r
54 <dd>The function failed due to a wrong FAT structure or an internal error.</dd>\r
55 <dt>FR_NOT_ENABLED</dt>\r
56 <dd>The logical drive has no work area.</dd>\r
57 <dt>FR_NO_FILESYSTEM</dt>\r
58 <dd>There is no valid FAT partition on the disk.</dd>\r
59 </dl>\r
60 </div>\r
61 \r
62 \r
63 <div class="para">\r
64 <h4>Description</h4>\r
65 <p>The f_mkdir function creates a new directory. This function is not supported in read-only configuration and minimization level of &gt;= 1.</p>\r
66 </div>\r
67 \r
68 \r
69 <div class="para">\r
70 <h4>Example</h4>\r
71 <pre>\r
72     res = f_mkdir("sub1");\r
73     if (res) die(res);\r
74     res = f_mkdir("sub1/sub2");\r
75     if (res) die(res);\r
76     res = f_mkdir("sub1/sub2/sub3");\r
77     if (res) die(res);\r
78 </pre>\r
79 </div>\r
80 \r
81 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
82 </body>\r
83 </html>\r