| Wiki Markup |
|---|
Section 7.19.5.3 of C99 places the following restrictions on update streams: \[[ISO/IEC 9899:1999|AA. C++ References#ISO/IEC 9899-1999]\] |
...
<blockquote><p>When a file is opened with update mode both input and output may be performed on the associated stream. However, output shall not be directly followed by input without an intervening call to the |
...
<code>fflush</code> function or to a file positioning function ( |
...
<code>fseek</code>, <code>fsetpos</code>, or <code>rewind</code>), and input shall not be directly followed by output without an intervening call to a file positioning function, unless the input operation encounters end-of-file. Opening (or creating) a text file with update mode may instead open (or create) a binary stream in some implementations. |
...
Receiving input from a stream directly following an output to that stream without an intervening call to fflush(), fseek(), fsetpos(), or rewind(), or outputting to a stream after receiving input from it without a call to fseek(), fsetpos(), rewind() if the file is not at end-of-file results in undefined behavior. Consequently, a call to fseek(), fflush() or fsetpos() is necessary between input and output to the same stream (see FIO07-CPP. Prefer fseek() to rewind()
</p></blockquote>Receiving input from a stream directly following an output to that stream without an intervening call to {{fflush()}}, {{fseek()}}, {{fsetpos()}}, or {{rewind()}}, or outputting to a stream after receiving input from it without a call to {{fseek()}}, {{fsetpos()}}, {{rewind()}} if the file is not at end-of-file results in [undefined behavior|BB. Definitions#undefined behavior]. Consequently, a call to {{fseek()}}, {{fflush()}} or {{fsetpos()}} is necessary between input and output to the same stream (see [FIO07-CPP. Prefer fseek() to rewind()|FIO07-CPP. Prefer fseek() to rewind()]). |
Noncompliant Code Example
This noncompliant code example appends data to a file and then reads from the same file.
| Code Block | ||
|---|---|---|
| ||
char data[BUFSIZBUFFERSIZE]; char append_data[BUFSIZBUFFERSIZE]; char *file_name; FILE *file; /* Initialize file_name */ file = fopen(file_name, "a+"); if (file == NULL) { /* Handle error */ } /* initialize append_data */ if (fwrite(append_data, BUFSIZBUFFERSIZE, 1, file) != BUFSIZBUFFERSIZE) { /* Handle error */ } if (fread(data, BUFSIZBUFFERSIZE, 1, file) != 0) { /* Handle there not being data */ } fclose(file); |
...
In this compliant solution, fseek() is called in between the output and input, eliminating the undefined behavior.
| Code Block | ||
|---|---|---|
| ||
char data[BUFSIZBUFFERSIZE]; char append_data[BUFSIZBUFFERSIZE]; char *file_name; FILE *file; /* initialize file_name */ file = fopen(file_name, "a+"); if (file == NULL) { /* Handle error */ } /* Initialize append_data */ if (fwrite(append_data, BUFSIZBUFFERSIZE, 1, file) != BUFSIZBUFFERSIZE) { /* Handle error */ } if (fseek(file, 0L, SEEK_SET) != 0) { /* Handle error */ } if (fread(data, BUFSIZBUFFERSIZE, 1, file) != 0) { /* Handle there not being data */ } fclose(file); |
...