aboutsummaryrefslogtreecommitdiff
path: root/doc/language/function/cpsc-function-eof.7.md
blob: 2f7e271d2002aaf2f109d35e96554555276ffe50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

% 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 throws an exception that TRY/CATCH can handle.

# 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)](../keyword/cpsc-keyword-openfile.7.md), [cpsc-keyword-readfile(7)](../keyword/cpsc-keyword-readfile.7.md), [cpsc-keyword-closefile(7)](../keyword/cpsc-keyword-closefile.7.md), [cpsc-keyword-try(7)](../keyword/cpsc-keyword-try.7.md).