fatfs/documents/doc/mkdir.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html lang="en">
   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_e.html">
   7 <link rel="alternate" hreflang="ja" title="Japanese" href="../ja/mkdir.html">
   8 <link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default">
   9 <title>FatFs - f_mkdir</title>
  10 </head>
  11
  12 <body>
  13
  14 <div class="para func">
  15 <h2>f_mkdir</h2>
  16 <p>The f_mkdir function creates a new directory.</p>
  17 <pre>
  18 FRESULT f_mkdir (
  19   const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Directory name */</span>
  20 );
  21 </pre>
  22 </div>
  23
  24 <div class="para arg">
  25 <h4>Parameter</h4>
  26 <dl class="par">
  27 <dt>path</dt>
  28 <dd>Pointer to the null-terminated string that specifies the <a href="filename.html">directory name</a> to create. </dd>
  29 </dl>
  30 </div>
  31
  32
  33 <div class="para ret">
  34 <h4>Return Value</h4>
  35 <p>
  36 <a href="rc.html#ok">FR_OK</a>,
  37 <a href="rc.html#de">FR_DISK_ERR</a>,
  38 <a href="rc.html#ie">FR_INT_ERR</a>,
  39 <a href="rc.html#nr">FR_NOT_READY</a>,
  40 <a href="rc.html#np">FR_NO_PATH</a>,
  41 <a href="rc.html#in">FR_INVALID_NAME</a>,
  42 <a href="rc.html#dn">FR_DENIED</a>,
  43 <a href="rc.html#ex">FR_EXIST</a>,
  44 <a href="rc.html#wp">FR_WRITE_PROTECTED</a>,
  45 <a href="rc.html#id">FR_INVALID_DRIVE</a>,
  46 <a href="rc.html#ne">FR_NOT_ENABLED</a>,
  47 <a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
  48 <a href="rc.html#tm">FR_TIMEOUT</a>,
  49 <a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
  50 </p>
  51 </div>
  52
  53
  54 <div class="para desc">
  55 <h4>Description</h4>
  56 <p>This function creates a new directory. To remove a directory, use <a href="unlink.html"><tt>f_unlink</tt></a> function.</p>
  57 </div>
  58
  59
  60 <div class="para comp">
  61 <h4>QuickInfo</h4>
  62 <p>Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> == 0</tt>.</p>
  63 </div>
  64
  65
  66 <div class="para use">
  67 <h4>Example</h4>
  68 <pre>
  69     res = <em>f_mkdir</em>("sub1");
  70     if (res) die(res);
  71     res = <em>f_mkdir</em>("sub1/sub2");
  72     if (res) die(res);
  73     res = <em>f_mkdir</em>("sub1/sub2/sub3");
  74     if (res) die(res);
  75 </pre>
  76 </div>
  77
  78 <p class="foot"><a href="../00index_e.html">Return</a></p>
  79 </body>
  80 </html>