diff options
author | sf <sf@13f79535-47bb-0310-9956-ffa450edef68> | 2011-02-26 18:53:22 +0000 |
---|---|---|
committer | sf <sf@13f79535-47bb-0310-9956-ffa450edef68> | 2011-02-26 18:53:22 +0000 |
commit | cf0bc7044bd47e5fe5209fbbe2b0cf55e8ab6224 (patch) | |
tree | 330f5bbfd9a7af459589d6302f59c5390199b6f1 /include/apr_file_io.h | |
parent | 3ab5bb71f7d93ab9a350fcf304f53a03a8533aec (diff) | |
download | libapr-cf0bc7044bd47e5fe5209fbbe2b0cf55e8ab6224.tar.gz |
clarify docs for apr_file_gets
git-svn-id: http://svn.apache.org/repos/asf/apr/apr/trunk@1074899 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'include/apr_file_io.h')
-rw-r--r-- | include/apr_file_io.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/include/apr_file_io.h b/include/apr_file_io.h index 97eaf4873..61b58ffb5 100644 --- a/include/apr_file_io.h +++ b/include/apr_file_io.h @@ -580,11 +580,12 @@ APR_DECLARE(apr_status_t) apr_file_getc(char *ch, apr_file_t *thefile); APR_DECLARE(apr_status_t) apr_file_ungetc(char ch, apr_file_t *thefile); /** - * Read a string from the specified file. + * Read a line from the specified file * @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 The buffer will be NUL-terminated if any characters are stored. + * The newline at the end of the line will not be stripped. */ APR_DECLARE(apr_status_t) apr_file_gets(char *str, int len, apr_file_t *thefile); |