Skip to content

Document the EOF behaviour for synchronous file handles with lpOverlapped #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MatchaMatch merged 1 commit into from
Feb 19, 2020
Merged

Document the EOF behaviour for synchronous file handles with lpOverlapped #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion sdk-api-src/content/fileapi/nf-fileapi-readfile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,9 +302,13 @@ Considerations for working with synchronous file handles:
<b>ReadFile</b> does not return until the read operation is
complete. The system updates the <b>OVERLAPPED</b> offset
before <b>ReadFile</b> returns.</li>
<li>When a synchronous read operation reaches the end of a file,
<li>If <i>lpOverlapped</i> is <b>NULL</b>, then when a synchronous read operation reaches the end of a file,
<b>ReadFile</b> returns <b>TRUE</b> and sets
<code>*lpNumberOfBytesRead</code> to zero.</li>
<li>If <i>lpOverlapped</i> is not <b>NULL</b>, then when a synchronous read operation reaches the end of a file,
<b>ReadFile</b> returns <b>FALSE</b> and
<a href="https://docs.microsoft.com/windows/desktop/api/errhandlingapi/nf-errhandlingapi-getlasterror">GetLastError</a> returns
<b>ERROR_HANDLE_EOF</b>.</li>
</ul>
For more information, see <a href="https://docs.microsoft.com/windows/desktop/api/fileapi/nf-fileapi-createfilea">CreateFile</a> and
<a href="https://docs.microsoft.com/windows/desktop/FileIO/synchronous-and-asynchronous-i-o">Synchronous and Asynchronous I/O</a>.
Expand Down