source: branches/gcc-kmk/include/HandleManager.h@ 21911

Last change on this file since 21911 was 21781, checked in by dmik, 14 years ago

Make Handle Manager functions compiler neutral with extern "C".
File size: 16.5 KB
Line 
1/*
2 * Project Odin Software License can be found in LICENSE.TXT
3 * Win32 Unified Handle Manager for OS/2
4 * 1998/02/11 PH Patrick Haller (haller@zebra.fh-weingarten.de)
5 *
6 * @(#) HandleManager.Cpp 1.0.0 1998/02/11 PH start
7 */
8
9#ifndef _HANDLEMANAGER_H_
10#define _HANDLEMANAGER_H_
11
12
13/*****************************************************************************
14 * Remark *
15 *****************************************************************************
16
17 1998/02/11 PH The interface to the handle manager is twofold:
18 a) HMxxx routines to be called from the "top" from the
19 KERNEL32 stubs
20 b) the HMDeviceHandler class is actually a workaround for
21 the device driver that would handle the requests on Win32.
22 To implement a new pseudo-device, one has create a new
23 HMDeviceHandler class and link it into the table in the
24 HANDLEMANAGER.CPP file.
25 */
26
27
28/*****************************************************************************
29 * Includes *
30 *****************************************************************************/
31
32#ifdef _OS2WIN_H
33#include <winos2def.h>
34#endif
35
36
37//LPSECURITY_ATTRIBUTES
38
39
40/*****************************************************************************
41 * Defines & Macros *
42 *****************************************************************************/
43
44 /* 1998/02/12 PH Correction of os2win.h */
45#undef FILE_TYPE_UNKNOWN
46#define FILE_TYPE_UNKNOWN 0x0000
47
48#undef FILE_TYPE_DISK
49#define FILE_TYPE_DISK 0x0001
50
51#undef FILE_TYPE_CHAR
52#define FILE_TYPE_CHAR 0x0002
53
54#undef FILE_TYPE_PIPE
55#define FILE_TYPE_PIPE 0x0003
56
57#undef FILE_TYPE_REMOTE
58#define FILE_TYPE_REMOTE 0x8000
59
60#ifndef INVALID_HANDLE_ERROR
61#define INVALID_HANDLE_ERROR (-1)
62#endif
63
64
65/*****************************************************************************
66 * Structures *
67 *****************************************************************************/
68
69#ifdef __cplusplus
70extern "C" {
71#endif
72
73/*****************************************************************************
74 * Prototypes *
75 *****************************************************************************/
76
77DWORD HMInitialize(void); /* initialize the HandleManager */
78
79DWORD HMTerminate(void); /* terminate the HandleManager */
80
81
82 /* handle manager version of GetStdHandle, Open32 can't really help us here */
83HANDLE HMGetStdHandle(DWORD nStdHandle);
84
85 /* handle manager version of GetStdHandle, Open32 can't really help us here */
86BOOL HMSetStdHandle(DWORD nStdHandle,
87 HANDLE hHandle);
88
89BOOL HMUpdtStdHandle(DWORD nStdHandle,
90 HANDLE hHandle);
91
92
93/*****************************************************************************/
94/* handle translation buffer management */
95/* */
96/* Since some Win32 applications rely (!) on 16-bit handles, we've got to do */
97/* 32-bit to 16-bit and vs vsa translation here. */
98/* Filehandle-based functions should be routed via the handlemanager instead */
99/* of going to Open32 directly. */
100/*****************************************************************************/
101
102DWORD HMHandleAllocate (PULONG phHandle16,
103 ULONG hHandle32);
104
105DWORD HMHandleFree (ULONG hHandle16);
106
107DWORD HMHandleGetUserData (ULONG hHandle16);
108DWORD HMHandleSetUserData (ULONG hHandle16, ULONG dwUserData);
109
110DWORD HMHandleValidate (ULONG hHandle16);
111
112DWORD HMHandleTranslateToWin (ULONG hHandle32,
113 PULONG phHandle16);
114
115DWORD HMHandleTranslateToOS2 (ULONG hHandle16,
116 PULONG hHandle32);
117
118DWORD HMHandleTranslateToOS2i(ULONG hHandle16);
119
120
121/*****************************************************************************
122 * Forwarders *
123 *****************************************************************************/
124
125HANDLE HMCreateEvent (LPSECURITY_ATTRIBUTES lpsa,
126 BOOL bManualReset,
127 BOOL bInitialState,
128 LPCSTR lpName);
129
130HANDLE HMCreateMutex (LPSECURITY_ATTRIBUTES lpsa,
131 BOOL bInitialOwner,
132 LPCSTR lpName);
133
134HANDLE HMCreateFile (LPCSTR lpFileName,
135 DWORD dwDesiredAccess,
136 DWORD dwShareMode,
137 LPSECURITY_ATTRIBUTES lpSecurityAttributes,
138 DWORD dwCreationDisposition,
139 DWORD dwFlagsAndAttributes,
140 HANDLE hTemplateFile);
141
142HANDLE HMOpenFile (LPCSTR lpFileName,
143 OFSTRUCT* pOFStruct,
144 UINT fuMode);
145
146HANDLE HMOpenEvent (DWORD fdwAccess,
147 BOOL fInherit,
148 LPCSTR lpName);
149
150HANDLE HMOpenMutex (DWORD fdwAccess,
151 BOOL fInherit,
152 LPCSTR lpName);
153
154BOOL HMSetHandleInformation (HANDLE hObject,
155 DWORD dwMask,
156 DWORD dwFlags);
157
158BOOL HMGetHandleInformation (HANDLE hObject,
159 LPDWORD lpdwFlags);
160
161BOOL HMCloseHandle (HANDLE hObject);
162
163BOOL HMReadFile (HANDLE hFile,
164 LPVOID lpBuffer,
165 DWORD nNumberOfBytesToRead,
166 LPDWORD lpNumberOfBytesRead,
167 LPOVERLAPPED lpOverlapped,
168 LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine);
169
170BOOL HMWriteFile (HANDLE hFile,
171 LPCVOID lpBuffer,
172 DWORD nNumberOfBytesToWrite,
173 LPDWORD lpNumberOfBytesWritten,
174 LPOVERLAPPED lpOverlapped,
175 LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine);
176
177DWORD HMGetFileType (HANDLE hFile);
178
179DWORD HMDeviceRequest (HANDLE hFile,
180 ULONG ulRequestCode,
181 ULONG arg1,
182 ULONG arg2,
183 ULONG arg3,
184 ULONG arg4);
185
186BOOL HMGetFileInformationByHandle (HANDLE hFile,
187 BY_HANDLE_FILE_INFORMATION *pHFI);
188
189BOOL HMSetEndOfFile (HANDLE hFile);
190
191BOOL HMSetFileTime (HANDLE hFile,
192 const FILETIME *pFT1,
193 const FILETIME *pFT2,
194 const FILETIME *pFT3);
195
196BOOL HMGetFileTime (HANDLE hFile,
197 const FILETIME *pFT1,
198 const FILETIME *pFT2,
199 const FILETIME *pFT3);
200
201DWORD HMGetFileSize (HANDLE hFile,
202 PDWORD pSize);
203
204DWORD HMSetFilePointer (HANDLE hFile,
205 LONG lDistanceToMove,
206 PLONG lpDistanceToMoveHigh,
207 DWORD dwMoveMethod);
208
209BOOL HMLockFile (HFILE hFile,
210 DWORD dwFileOffsetLow,
211 DWORD dwFileOffsetHigh,
212 DWORD nNumberOfBytesToLockLow,
213 DWORD nNumberOfBytesToLockHigh);
214
215BOOL HMLockFileEx (HANDLE hFile,
216 DWORD dwFlags,
217 DWORD dwReserved,
218 DWORD nNumberOfBytesToLockLow,
219 DWORD nNumberOfBytesToLockHigh,
220 LPOVERLAPPED lpOverlapped);
221
222BOOL HMUnlockFile (HANDLE hFile,
223 DWORD dwFileOffsetLow,
224 DWORD dwFileOffsetHigh,
225 DWORD cbUnlockLow,
226 DWORD cbUnlockHigh);
227
228BOOL HMUnlockFileEx (HANDLE hFile,
229 DWORD dwReserved,
230 DWORD nNumberOfBytesToLockLow,
231 DWORD nNumberOfBytesToLockHigh,
232 LPOVERLAPPED lpOverlapped);
233
234DWORD HMWaitForSingleObject (HANDLE hObject,
235 DWORD dwTimeout);
236
237DWORD HMWaitForSingleObjectEx (HANDLE hObject,
238 DWORD dwTimeout,
239 BOOL fAlertable);
240
241DWORD HMWaitForMultipleObjects (DWORD cObjects,
242 HANDLE *lphObjects,
243 BOOL fWaitAll,
244 DWORD dwTimeout);
245
246DWORD HMWaitForMultipleObjectsEx (DWORD cObjects,
247 HANDLE *lphObjects,
248 BOOL fWaitAll,
249 DWORD dwTimeout,
250 BOOL fAlertable);
251
252DWORD HMMsgWaitForMultipleObjects (DWORD nCount,
253 HANDLE *pHandles,
254 BOOL fWaitAll,
255 DWORD dwMilliseconds,
256 DWORD dwWakeMask);
257
258BOOL HMDeviceIoControl (HANDLE hDevice,
259 DWORD dwIoControlCode,
260 LPVOID lpInBuffer,
261 DWORD nInBufferSize,
262 LPVOID lpOutBuffer,
263 DWORD nOutBufferSize,
264 LPDWORD lpBytesReturned,
265 LPOVERLAPPED lpOverlapped);
266
267BOOL HMCancelIo (HANDLE hDevice);
268
269BOOL HMFlushFileBuffers (HANDLE hObject);
270
271BOOL HMGetOverlappedResult (HANDLE hObject,
272 LPOVERLAPPED lpOverlapped,
273 LPDWORD lpNumberOfBytesTransferred,
274 BOOL bWait);
275
276BOOL HMReleaseMutex (HANDLE hObject);
277
278BOOL HMSetEvent (HANDLE hEvent);
279
280BOOL HMPulseEvent (HANDLE hEvent);
281
282BOOL HMResetEvent (HANDLE hEvent);
283
284HANDLE HMCreateSemaphore (LPSECURITY_ATTRIBUTES lpsa,
285 LONG lInitialCount,
286 LONG lMaximumCount,
287 LPCSTR lpszSemaphoreName);
288
289HANDLE HMOpenSemaphore (DWORD fdwAccess,
290 BOOL fInheritHandle,
291 LPCSTR lpszSemaphoreName);
292
293BOOL HMReleaseSemaphore (HANDLE hSemaphore,
294 LONG cReleaseCount,
295 LPLONG lpPreviousCount);
296
297
298HANDLE HMCreateFileMapping(
299 HANDLE hFile, /* [in] Handle of file to map */
300 SECURITY_ATTRIBUTES *sa, /* [in] Optional security attributes*/
301 DWORD protect, /* [in] Protection for mapping object */
302 DWORD size_high, /* [in] High-order 32 bits of object size */
303 DWORD size_low, /* [in] Low-order 32 bits of object size */
304 LPCSTR name); /* [in] Name of file-mapping object */
305
306HANDLE HMOpenFileMapping(
307 DWORD access, /* [in] Access mode */
308 BOOL inherit, /* [in] Inherit flag */
309 LPCSTR name ); /* [in] Name of file-mapping object */
310
311LPVOID HMMapViewOfFileEx (HANDLE hFileMappingObject,
312 DWORD dwDesiredAccess,
313 DWORD dwFileOffsetHigh,
314 DWORD dwFileOffsetLow,
315 DWORD dwNumberOfBytesToMap,
316 LPVOID lpBaseAddress);
317
318BOOL HMDuplicateHandle(HANDLE srcprocess,
319 HANDLE srchandle,
320 HANDLE destprocess,
321 PHANDLE desthandle,
322 DWORD fdwAccess,
323 BOOL fInherit,
324 DWORD fdwOptions);
325
326DWORD HMOpenThreadToken(HANDLE ThreadHandle,
327 DWORD DesiredAccess,
328 DWORD OpenAsSelf,
329 HANDLE *TokenHandle);
330
331DWORD HMOpenProcessToken(HANDLE ProcessHandle,
332 DWORD DesiredAccess,
333 DWORD dwUserData,
334 HANDLE *TokenHandle);
335
336
337HANDLE HMCreateThread(LPSECURITY_ATTRIBUTES lpsa,
338 DWORD cbStack,
339 LPTHREAD_START_ROUTINE lpStartAddr,
340 LPVOID lpvThreadParm,
341 DWORD fdwCreate,
342 LPDWORD lpIDThread,
343 BOOL fRegisterThread = FALSE);
344BOOL HMSetThreadTerminated(HANDLE hThread);
345
346
347BOOL HMGetFileNameFromHandle(HANDLE hFile, LPSTR lpszFileName, DWORD cbFileName);
348
349#ifdef __cplusplus
350} // extern "C"
351#endif
352
353#endif /* _HANDLEMANAGER_H_ */
Note: See TracBrowser for help on using the repository browser.