1.1 --- a/plugins/include/files.inc	Sat Nov 29 20:07:43 2008 -0600
     1.2 +++ b/plugins/include/files.inc	Sat Nov 29 22:43:30 2008 -0600
     1.3 @@ -176,11 +176,11 @@
     1.4   * @param hndl			Handle to the file.
     1.5   * @param buffer		Buffer to store the string.
     1.6   * @param max_size		Maximum size of the string buffer.
     1.7 - * @param stop			If true, reading will stop once max_size-1 bytes have 
     1.8 - *						been read.  If false, reading will stop once a NUL 
     1.9 - *						terminator is reached.  The buffer will simply be 
    1.10 - *						terminated in either case, the difference is in how 
    1.11 - *						the far the file position is changed.
    1.12 + * @param read_count	If -1, reads until a null terminator is encountered in 
    1.13 + *						the file.  Otherwise, read_count bytes are read 
    1.14 + *						into the buffer provided.  In this case the buffer 
    1.15 + *						is not explicitly null terminated, and the buffer 
    1.16 + *						will contain any null terminators read from the file.
    1.17   * @return				Number of characters written to the buffer, or -1 
    1.18   *						if an error was encountered.
    1.19   * @error				Invalid Handle, or read_count > max_size.