ReactOS 0.4.17-dev-205-g2e13f97
ReadFile.c
Go to the documentation of this file.
1/*
2 * PROJECT: ReactOS API tests
3 * LICENSE: MIT (https://spdx.org/licenses/MIT)
4 * PURPOSE: Test for ReadFile
5 * COPYRIGHT: Copyright 2026 Timo Kreuzer <timo.kreuzer@reactos.org>
6 */
7
8#include "precomp.h"
9
10static void Test_ReadFile_sync(HANDLE hFile)
11{
12 UCHAR Buffer[128];
13 DWORD dwBytesRead;
14 BOOL bResult;
15
16 SetFilePointer(hFile, 0, NULL, FILE_BEGIN);
17
18 /* Test NULL File */
19 SetLastError(0xdeadbeef);
20 dwBytesRead = 0xdeadbeef;
21 bResult = ReadFile(NULL, Buffer, sizeof(Buffer), &dwBytesRead, NULL);
22 ok_eq_bool(bResult, FALSE);
23 ok_eq_ulong(dwBytesRead, 0);
24 ok_eq_ulong(GetLastError(), ERROR_INVALID_HANDLE);
25
26 /* Test INVALID_HANDLE_VALUE */
27 SetLastError(0xdeadbeef);
28 dwBytesRead = 0xdeadbeef;
29 bResult = ReadFile(INVALID_HANDLE_VALUE, Buffer, sizeof(Buffer), &dwBytesRead, NULL);
30 ok_eq_bool(bResult, FALSE);
31 ok_eq_ulong(dwBytesRead, 0);
32 ok_eq_ulong(GetLastError(), ERROR_INVALID_HANDLE);
33
34 /* Read some bytes */
35 SetLastError(0xdeadbeef);
36 dwBytesRead = 0xdeadbeef;
37 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), &dwBytesRead, NULL);
38 ok_eq_bool(bResult, TRUE);
39 ok_eq_ulong(dwBytesRead, sizeof(Buffer));
40 ok_eq_ulong(GetLastError(), 0xdeadbeef);
41
42 /* Try to read at end of file */
43 SetLastError(0xdeadbeef);
44 dwBytesRead = 0xdeadbeef;
45 ok(SetFilePointer(hFile, 0, NULL, FILE_END) > 0, "SetFilePointer failed\n");
46 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), &dwBytesRead, NULL);
47 ok_eq_bool(bResult, TRUE);
48 ok_eq_ulong(dwBytesRead, 0);
49 ok_eq_ulong(GetLastError(), 0xdeadbeef);
50
51 /* Try to read 0 bytes at end of file */
52 SetLastError(0xdeadbeef);
53 bResult = ReadFile(hFile, Buffer, 0, &dwBytesRead, NULL);
54 ok_eq_bool(bResult, TRUE);
55 ok_eq_ulong(dwBytesRead, 0);
56 ok_eq_ulong(GetLastError(), 0xdeadbeef);
57 SetFilePointer(hFile, 0, NULL, FILE_BEGIN);
58
59 /* Test with NULL lpBuffer */
60 SetLastError(0xdeadbeef);
61 dwBytesRead = 0xdeadbeef;
62 StartSeh()
63 bResult = ReadFile(hFile, NULL, sizeof(Buffer), &dwBytesRead, NULL);
64 ok_eq_bool(bResult, FALSE);
65 ok_eq_ulong(dwBytesRead, 0);
66 ok_eq_ulong(GetLastError(), ERROR_NOACCESS);
67 EndSeh(STATUS_SUCCESS);
68
69 /* Test with NULL lpBuffer and 0 nNumberOfBytesToRead */
70 SetLastError(0xdeadbeef);
71 dwBytesRead = 0xdeadbeef;
72 StartSeh()
73 bResult = ReadFile(hFile, NULL, 0, &dwBytesRead, NULL);
74 ok_eq_bool(bResult, TRUE);
75 ok_eq_ulong(dwBytesRead, 0);
76 ok_eq_ulong(GetLastError(), 0xdeadbeef);
77 EndSeh(STATUS_SUCCESS);
78
79 /* Test with NULL lpNumberOfBytesRead */
80 SetLastError(0xdeadbeef);
81 StartSeh()
82 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), NULL, NULL);
83 ok_eq_bool(bResult, TRUE);
84 ok_eq_ulong(GetLastError(), 0xdeadbeef);
85 EndSeh(is_reactos() || (GetNTVersion() >= _WIN32_WINNT_WIN8) ? STATUS_SUCCESS : EXCEPTION_ACCESS_VIOLATION);
86
87 /* Test with NULL lpNumberOfBytesRead at end of file */
88 ok(SetFilePointer(hFile, 0, NULL, FILE_END) > 0, "SetFilePointer failed\n");
89 SetLastError(0xdeadbeef);
90 StartSeh()
91 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), NULL, NULL);
92 ok_eq_bool(bResult, TRUE);
93 ok_eq_ulong(GetLastError(), 0xdeadbeef);
94 EndSeh(is_reactos() || (GetNTVersion() >= _WIN32_WINNT_WIN8) ? STATUS_SUCCESS : EXCEPTION_ACCESS_VIOLATION);
95}
96
97static void Test_ReadFile_async(HANDLE hFile)
98{
99 BOOL bResult;
100 UCHAR Buffer[128];
101 DWORD dwBytesRead;
102 OVERLAPPED ol = { 0 };
103
104 SetFilePointer(hFile, 0, NULL, FILE_BEGIN);
105
106 /* Test NULL File */
107 SetLastError(0xdeadbeef);
108 dwBytesRead = 0xdeadbeef;
109 bResult = ReadFile(NULL, Buffer, sizeof(Buffer), &dwBytesRead, &ol);
110 ok_eq_bool(bResult, FALSE);
111 ok_eq_ulong(dwBytesRead, 0);
112 ok_eq_ulong(GetLastError(), ERROR_INVALID_HANDLE);
113
114 /* Test INVALID_HANDLE_VALUE */
115 SetLastError(0xdeadbeef);
116 dwBytesRead = 0xdeadbeef;
117 bResult = ReadFile(INVALID_HANDLE_VALUE, Buffer, sizeof(Buffer), &dwBytesRead, &ol);
118 ok_eq_bool(bResult, FALSE);
119 ok_eq_ulong(dwBytesRead, 0);
120 ok_eq_ulong(GetLastError(), ERROR_INVALID_HANDLE);
121
122 /* Read some bytes */
123 SetLastError(0xdeadbeef);
124 dwBytesRead = 0xdeadbeef;
125 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), &dwBytesRead, &ol);
126 ok_eq_bool(bResult, TRUE);
127 dwBytesRead = 0xdeadbeef;
128 bResult = GetOverlappedResult(hFile, &ol, &dwBytesRead, TRUE);
129 ok_eq_bool(bResult, TRUE);
130 ok_eq_ulong(dwBytesRead, sizeof(Buffer));
131 ok_eq_ulong(GetLastError(), (GetNTVersion() >= _WIN32_WINNT_WIN10) ? 0 : 0xdeadbeef);
132
133 /* Try to read at end of file */
134 SetLastError(0xdeadbeef);
135 dwBytesRead = 0xdeadbeef;
136 ol.Offset = GetFileSize(hFile, NULL);
137 ok(ol.Offset > 0, "GetFileSize failed\n");
138 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), &dwBytesRead, &ol);
139 ok_eq_bool(bResult, FALSE);
140 ok_eq_ulong(dwBytesRead, 0);
141 ok_eq_ulong(GetLastError(), ERROR_HANDLE_EOF);
142
143 /* Try to read 0 bytes at end of file */
144 SetLastError(0xdeadbeef);
145 bResult = ReadFile(hFile, Buffer, 0, &dwBytesRead, &ol);
146 ok_eq_bool(bResult, TRUE);
147 ok_eq_ulong(dwBytesRead, 0);
148 ok_eq_ulong(GetLastError(), 0xdeadbeef);
149 ol.Offset = 0;
150
151 /* Test with NULL lpBuffer */
152 SetLastError(0xdeadbeef);
153 dwBytesRead = 0xdeadbeef;
154 StartSeh()
155 bResult = ReadFile(hFile, NULL, sizeof(Buffer), &dwBytesRead, &ol);
156 ok_eq_bool(bResult, FALSE);
157 ok_eq_ulong(GetLastError(), ERROR_NOACCESS);
158 EndSeh(STATUS_SUCCESS);
159
160 /* Test with NULL lpBuffer and 0 nNumberOfBytesToRead */
161 SetLastError(0xdeadbeef);
162 dwBytesRead = 0xdeadbeef;
163 StartSeh()
164 bResult = ReadFile(hFile, NULL, 0, &dwBytesRead, &ol);
165 ok_eq_bool(bResult, TRUE);
166 ok_eq_ulong(GetLastError(), 0xdeadbeef);
167 bResult = GetOverlappedResult(hFile, &ol, &dwBytesRead, TRUE);
168 ok_eq_bool(bResult, TRUE);
169 ok_eq_ulong(dwBytesRead, 0);
170 ok_eq_ulong(GetLastError(), (GetNTVersion() >= _WIN32_WINNT_WIN10) ? 0 : 0xdeadbeef);
171 EndSeh(STATUS_SUCCESS);
172
173 /* Test with NULL lpNumberOfBytesRead */
174 SetLastError(0xdeadbeef);
175 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), NULL, &ol);
176 ok_eq_bool(bResult, TRUE);
177 ok_eq_ulong(GetLastError(), 0xdeadbeef);
178 bResult = GetOverlappedResult(hFile, &ol, &dwBytesRead, TRUE);
179 ok_eq_bool(bResult, TRUE);
180 ok_eq_ulong(dwBytesRead, sizeof(Buffer));
181 ok_eq_ulong(GetLastError(), (GetNTVersion() >= _WIN32_WINNT_WIN10) ? 0 : 0xdeadbeef);
182
183 /* Test with NULL lpNumberOfBytesRead at end of file */
184 SetLastError(0xdeadbeef);
185 ol.Offset = GetFileSize(hFile, NULL);
186 ok(ol.Offset > 0, "GetFileSize failed\n");
187 bResult = ReadFile(hFile, Buffer, sizeof(Buffer), NULL, &ol);
188 ok_eq_bool(bResult, FALSE);
189 ok_eq_ulong(GetLastError(), ERROR_HANDLE_EOF);
190 SetLastError(0xdeadbeef);
191 dwBytesRead = 0xdeadbeef;
192 bResult = GetOverlappedResult(hFile, &ol, &dwBytesRead, TRUE);
193 ok_eq_bool(bResult, FALSE);
194 ok_eq_ulong(dwBytesRead, 0);
195 ok_eq_ulong(GetLastError(), ERROR_HANDLE_EOF);
196 ol.Offset = 0;
197}
198
199START_TEST(ReadFile)
200{
201 CHAR FileName[MAX_PATH];
202 HANDLE hFile;
203
204 /* Open the executable file */
205 GetModuleFileNameA(NULL, FileName, ARRAYSIZE(FileName));
206 hFile = CreateFileA(FileName,
207 FILE_READ_ACCESS,
208 FILE_SHARE_READ,
209 NULL,
210 OPEN_EXISTING,
211 FILE_ATTRIBUTE_NORMAL,
212 NULL);
213 if (hFile == INVALID_HANDLE_VALUE)
214 {
215 skip("CreateFileA failed with error %lu\n", GetLastError());
216 return;
217 }
218
219 Test_ReadFile_sync(hFile);
220 Test_ReadFile_async(hFile);
221
222 CloseHandle(hFile);
223}
Test_ReadFile_sync
static void Test_ReadFile_sync(HANDLE hFile)
Definition: ReadFile.c:10
Test_ReadFile_async
static void Test_ReadFile_async(HANDLE hFile)
Definition: ReadFile.c:97
ok_eq_ulong
#define ok_eq_ulong(value, expected)
Definition: apitest.h:120
GetNTVersion
#define GetNTVersion()
Definition: apitest.h:17
StartSeh
#define StartSeh()
Definition: apitest.h:93
ok_eq_bool
#define ok_eq_bool(value, expected)
Definition: apitest.h:137
EndSeh
#define EndSeh(ExpectedStatus)
Definition: apitest.h:99
ok
#define ok(value,...)
Definition: atltest.h:57
skip
#define skip(...)
Definition: atltest.h:64
START_TEST
#define START_TEST(x)
Definition: atltest.h:75
Buffer
Definition: bufpool.h:45
NULL
#define NULL
Definition: types.h:112
TRUE
#define TRUE
Definition: types.h:120
FALSE
#define FALSE
Definition: types.h:117
ARRAYSIZE
#define ARRAYSIZE(array)
Definition: filtermapper.c:47
CloseHandle
#define CloseHandle
Definition: compat.h:739
FILE_BEGIN
#define FILE_BEGIN
Definition: compat.h:761
OPEN_EXISTING
#define OPEN_EXISTING
Definition: compat.h:775
ReadFile
#define ReadFile(a, b, c, d, e)
Definition: compat.h:742
SetFilePointer
#define SetFilePointer
Definition: compat.h:743
SetLastError
#define SetLastError(x)
Definition: compat.h:752
INVALID_HANDLE_VALUE
#define INVALID_HANDLE_VALUE
Definition: compat.h:731
CreateFileA
#define CreateFileA(a, b, c, d, e, f, g)
Definition: compat.h:740
MAX_PATH
#define MAX_PATH
Definition: compat.h:34
ERROR_INVALID_HANDLE
#define ERROR_INVALID_HANDLE
Definition: compat.h:98
FILE_ATTRIBUTE_NORMAL
#define FILE_ATTRIBUTE_NORMAL
Definition: compat.h:137
FILE_SHARE_READ
#define FILE_SHARE_READ
Definition: compat.h:136
GetFileSize
DWORD WINAPI GetFileSize(HANDLE hFile, LPDWORD lpFileSizeHigh)
Definition: fileinfo.c:331
GetModuleFileNameA
DWORD WINAPI GetModuleFileNameA(HINSTANCE hModule, LPSTR lpFilename, DWORD nSize)
Definition: loader.c:539
BOOL
unsigned int BOOL
Definition: ntddk_ex.h:94
DWORD
unsigned long DWORD
Definition: ntddk_ex.h:95
GetOverlappedResult
BOOL WINAPI GetOverlappedResult(IN HANDLE hFile, IN LPOVERLAPPED lpOverlapped, OUT LPDWORD lpNumberOfBytesTransferred, IN BOOL bWait)
Definition: iocompl.c:221
EXCEPTION_ACCESS_VIOLATION
#define EXCEPTION_ACCESS_VIOLATION
Definition: minwinbase.h:44
hFile
_In_ HANDLE hFile
Definition: mswsock.h:90
FILE_READ_ACCESS
#define FILE_READ_ACCESS
Definition: nt_native.h:610
CHAR
char CHAR
Definition: pedump.c:57
_WIN32_WINNT_WIN10
#define _WIN32_WINNT_WIN10
Definition: sdkddkver.h:32
_WIN32_WINNT_WIN8
#define _WIN32_WINNT_WIN8
Definition: sdkddkver.h:29
STATUS_SUCCESS
#define STATUS_SUCCESS
Definition: shellext.h:65
_FileName
Definition: filecomp.c:348
_OVERLAPPED
Definition: minwinbase.h:218
_OVERLAPPED::Offset
DWORD Offset
Definition: minwinbase.h:225
UCHAR
unsigned char UCHAR
Definition: typedefs.h:53
FILE_END
#define FILE_END
Definition: winbase.h:116
GetLastError
DWORD WINAPI GetLastError(void)
Definition: except.c:1042
ERROR_HANDLE_EOF
#define ERROR_HANDLE_EOF
Definition: winerror.h:262
ERROR_NOACCESS
#define ERROR_NOACCESS
Definition: winerror.h:902