cvs commit: apr/include apr_file_io.h

[trawick]

trawick     2003/04/03 15:20:05

  Modified:    include  apr_file_io.h
  Log:
  add some additional information to the documentation of
  apr_file_gets()
  
  Revision  Changes    Path
  1.138     +4 -0      apr/include/apr_file_io.h
  
  Index: apr_file_io.h
  ===================================================================
  RCS file: /home/cvs/apr/include/apr_file_io.h,v
  retrieving revision 1.137
  retrieving revision 1.138
  diff -u -r1.137 -r1.138
  --- apr_file_io.h     5 Mar 2003 21:22:25 -0000       1.137
  +++ apr_file_io.h     3 Apr 2003 23:20:05 -0000       1.138
  @@ -451,6 +451,10 @@
    * @param str The buffer to store the string in. 
    * @param len The length of the string
    * @param thefile The file descriptor to read from
  + * @remark APR_EOF will be returned if some characters are read but the end
  + * of file is reached before a newline is read.
  + * @remark The buffer will be '\0'-terminated if any characters are stored,
  + * even if something other than APR_SUCCESS is returned.
    */
   APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, apr_file_t 
*thefile);