summaryrefslogtreecommitdiff
path: root/lib/freadptr.h
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2008-02-29 00:58:02 +0100
committerBruno Haible <bruno@clisp.org>2008-02-29 00:58:02 +0100
commite8014c6b48c5e156b61c09cf7e5681b64c644344 (patch)
treedd8306d166f4f8c61037d35631134298072544c7 /lib/freadptr.h
parent1ddcbefb7c81bc5e01fd8da38165bed54ca0cfd4 (diff)
downloadgnulib-e8014c6b48c5e156b61c09cf7e5681b64c644344.tar.gz
Change specification for the sake of ungetc on hypothetic platforms.
Diffstat (limited to 'lib/freadptr.h')
-rw-r--r--lib/freadptr.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/freadptr.h b/lib/freadptr.h
index 7697970703..3620a14372 100644
--- a/lib/freadptr.h
+++ b/lib/freadptr.h
@@ -23,8 +23,9 @@ extern "C" {
/* Assuming the stream STREAM is open for reading:
Return a pointer to the input buffer of STREAM.
- If freadahead (STREAM) > 0, the result is a pointer to freadahead (STREAM)
- bytes.
+ If freadahead (STREAM) > 0, the result is either a pointer to
+ freadahead (STREAM) bytes, or NULL. The latter case can happen after
+ use of 'ungetc (..., STREAM)'.
If freadahead (STREAM) == 0, the result is not usable; it may be NULL.
In this case, you should use getc (STREAM), fgetc (STREAM), or
fread (..., STREAM) to access the input from STREAM.