git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/Common/FileSystem/FatFs-0.7e/doc/en/gets.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_gets</title>\r
   9 </head>\r
  10 \r
  11 <body>\r
  12 \r
  13 <div class="para">\r
  14 <h2>f_gets</h2>\r
  15 <p>The f_gets reads a string from the file.</p>\r
  16 <pre>\r
  17 char* f_gets (\r
  18   char* <em>Str</em>,        /* Read buffer */\r
  19   int <em>Size</em>,         /* Size of the read buffer */\r
  20   FIL* <em>FileObject</em>   /* File object */\r
  21 );\r
  22 </pre>\r
  23 </div>\r
  24 \r
  25 <div class="para">\r
  26 <h4>Parameters</h4>\r
  27 <dl class="par">\r
  28 <dt>Str</dt>\r
  29 <dd>Pointer to read buffer to store the read string.</dd>\r
  30 <dt>Size</dt>\r
  31 <dd>Size of the read buffer.</dd>\r
  32 <dt>FileObject</dt>\r
  33 <dd>Pointer to the open file object structure.</dd>\r
  34 </dl>\r
  35 </div>\r
  36 \r
  37 \r
  38 <div class="para">\r
  39 <h4>Return Values</h4>\r
  40 <p>When the function succeeded, <tt>Str</tt> will be returuned.</p>\r
  41 </div>\r
  42 \r
  43 \r
  44 <div class="para">\r
  45 <h4>Description</h4>\r
  46 <p>The f_gets() is a wrapper function of <a href="read.html">f_read()</a>. The read operation continues until a <tt>'\n'</tt> is stored, reached end of file or buffer is filled with Size - 1 characters. The read string is terminated with a <tt>'\0'</tt>. When the file has reached end of the file or any error occured during read operation, f_gets() returns a <tt>NULL</tt>. The EOF and error status can be examined with <tt>f_eof()</tt> and <tt>f_error()</tt> macro.</p>\r
  47 </div>\r
  48 \r
  49 \r
  50 <div class="para">\r
  51 <h4>QuickInfo</h4>\r
  52 <p>Available when <tt>_USE_STRFUNC</tt> is 1 or 2. When it is set to 2, <tt>'\r'</tt>s contained in the file are stripped out.</p>\r
  53 </div>\r
  54 \r
  55 \r
  56 <div class="para">\r
  57 <h4>See Also</h4>\r
  58 <p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="putc.html">f_putc</a>, <a href="puts.html">f_puts</a>, <a href="printf.html">f_printf</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>\r
  59 </div>\r
  60 \r
  61 <p class="foot"><a href="../00index_e.html">Return</a></p>\r
  62 </body>\r
  63 </html>\r