aboutsummaryrefslogtreecommitdiff
path: root/doc/language/cpsc-function-eof.7.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/language/cpsc-function-eof.7.md')
-rw-r--r--doc/language/cpsc-function-eof.7.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/language/cpsc-function-eof.7.md b/doc/language/cpsc-function-eof.7.md
new file mode 100644
index 0000000..721e667
--- /dev/null
+++ b/doc/language/cpsc-function-eof.7.md
@@ -0,0 +1,34 @@
+% CPSC-FUNCTION-EOF(7)
+
+# NAME
+
+cpsc-function-eof - test for the end of a text file
+
+# SYNOPSIS
+
+```text
+EOF(filename : STRING) RETURNS BOOLEAN
+```
+
+# DESCRIPTION
+
+Return true when no further characters remain in a file opened FOR READ.
+The test does not consume the next character. Testing an unopened file or
+a file in the wrong mode terminates execution.
+
+# EXAMPLE
+
+```text
+DECLARE Line : STRING
+OPENFILE "notes.txt" FOR READ
+WHILE NOT EOF("notes.txt") DO
+ READFILE "notes.txt", Line
+ OUTPUT Line
+ENDWHILE
+CLOSEFILE "notes.txt"
+```
+
+# SEE ALSO
+
+[cpsc-language-overview(7)](cpsc-language-overview.7.md), [cpsc-keyword-openfile(7)](cpsc-keyword-openfile.7.md), [cpsc-keyword-readfile(7)](cpsc-keyword-readfile.7.md), [cpsc-keyword-closefile(7)](cpsc-keyword-closefile.7.md).
+