Context Navigation

source: trunk/include/HandleManager.h@ 9652

Visit:

Last change on this file since 9652 was 9652, checked in by sandervl, 23 years ago
header updates
File size: 23.3 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
70	/*****************************************************************************
71	* Prototypes *
72	*****************************************************************************/
73
74	DWORD HMInitialize(void); /* initialize the HandleManager */
75
76	DWORD HMTerminate(void); /* terminate the HandleManager */
77
78
79	/* handle manager version of GetStdHandle, Open32 can't really help us here */
80	HANDLE HMGetStdHandle(DWORD nStdHandle);
81
82	/* handle manager version of GetStdHandle, Open32 can't really help us here */
83	BOOL HMSetStdHandle(DWORD nStdHandle,
84	HANDLE hHandle);
85
86
87	/*****************************************************************************/
88	/* handle translation buffer management */
89	/* */
90	/* Since some Win32 applications rely (!) on 16-bit handles, we've got to do */
91	/* 32-bit to 16-bit and vs vsa translation here. */
92	/* Filehandle-based functions should be routed via the handlemanager instead */
93	/* of going to Open32 directly. */
94	/*****************************************************************************/
95
96	DWORD HMHandleAllocate (PULONG phHandle16,
97	ULONG hHandle32);
98
99	DWORD HMHandleFree (ULONG hHandle16);
100
101	DWORD HMHandleGetUserData (ULONG hHandle16);
102	DWORD HMHandleSetUserData (ULONG hHandle16, ULONG dwUserData);
103
104	DWORD HMHandleValidate (ULONG hHandle16);
105
106	DWORD HMHandleTranslateToWin (ULONG hHandle32,
107	PULONG phHandle16);
108
109	DWORD HMHandleTranslateToOS2 (ULONG hHandle16,
110	PULONG hHandle32);
111
112	DWORD HMHandleTranslateToOS2i(ULONG hHandle16);
113
114
115	/*****************************************************************************
116	* Forwarders *
117	*****************************************************************************/
118
119	// enable C linkage to avoid parameter mangling
120	#ifdef __cplusplus__
121	extern "C" {
122	#endif
123
124	HANDLE HMCreateEvent (LPSECURITY_ATTRIBUTES lpsa,
125	BOOL bManualReset,
126	BOOL bInitialState,
127	LPCSTR lpName);
128
129	HANDLE HMCreateMutex (LPSECURITY_ATTRIBUTES lpsa,
130	BOOL bInitialOwner,
131	LPCSTR lpName);
132
133	HANDLE HMCreateFile (LPCSTR lpFileName,
134	DWORD dwDesiredAccess,
135	DWORD dwShareMode,
136	LPSECURITY_ATTRIBUTES lpSecurityAttributes,
137	DWORD dwCreationDisposition,
138	DWORD dwFlagsAndAttributes,
139	HANDLE hTemplateFile);
140
141	HANDLE HMOpenFile (LPCSTR lpFileName,
142	OFSTRUCT* pOFStruct,
143	UINT fuMode);
144
145	HANDLE HMOpenEvent (DWORD fdwAccess,
146	BOOL fInherit,
147	LPCSTR lpName);
148
149	HANDLE HMOpenMutex (DWORD fdwAccess,
150	BOOL fInherit,
151	LPCSTR lpName);
152
153	BOOL HMSetHandleInformation (HANDLE hObject,
154	DWORD dwMask,
155	DWORD dwFlags);
156
157	BOOL HMGetHandleInformation (HANDLE hObject,
158	LPDWORD lpdwFlags);
159
160	BOOL HMCloseHandle (HANDLE hObject);
161
162	BOOL HMReadFile (HANDLE hFile,
163	LPVOID lpBuffer,
164	DWORD nNumberOfBytesToRead,
165	LPDWORD lpNumberOfBytesRead,
166	LPOVERLAPPED lpOverlapped,
167	LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine);
168
169	BOOL HMWriteFile (HANDLE hFile,
170	LPCVOID lpBuffer,
171	DWORD nNumberOfBytesToWrite,
172	LPDWORD lpNumberOfBytesWritten,
173	LPOVERLAPPED lpOverlapped,
174	LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine);
175
176	DWORD HMGetFileType (HANDLE hFile);
177
178	DWORD HMDeviceRequest (HANDLE hFile,
179	ULONG ulRequestCode,
180	ULONG arg1,
181	ULONG arg2,
182	ULONG arg3,
183	ULONG arg4);
184
185	BOOL HMGetFileInformationByHandle (HANDLE hFile,
186	BY_HANDLE_FILE_INFORMATION *pHFI);
187
188	BOOL HMSetEndOfFile (HANDLE hFile);
189
190	BOOL HMSetFileTime (HANDLE hFile,
191	const FILETIME *pFT1,
192	const FILETIME *pFT2,
193	const FILETIME *pFT3);
194
195	BOOL HMGetFileTime (HANDLE hFile,
196	const FILETIME *pFT1,
197	const FILETIME *pFT2,
198	const FILETIME *pFT3);
199
200	DWORD HMGetFileSize (HANDLE hFile,
201	PDWORD pSize);
202
203	DWORD HMSetFilePointer (HANDLE hFile,
204	LONG lDistanceToMove,
205	PLONG lpDistanceToMoveHigh,
206	DWORD dwMoveMethod);
207
208	BOOL HMLockFile (HFILE hFile,
209	DWORD dwFileOffsetLow,
210	DWORD dwFileOffsetHigh,
211	DWORD nNumberOfBytesToLockLow,
212	DWORD nNumberOfBytesToLockHigh);
213
214	BOOL HMLockFileEx (HANDLE hFile,
215	DWORD dwFlags,
216	DWORD dwReserved,
217	DWORD nNumberOfBytesToLockLow,
218	DWORD nNumberOfBytesToLockHigh,
219	LPOVERLAPPED lpOverlapped);
220
221	BOOL HMUnlockFile (HANDLE hFile,
222	DWORD dwFileOffsetLow,
223	DWORD dwFileOffsetHigh,
224	DWORD cbUnlockLow,
225	DWORD cbUnlockHigh);
226
227	BOOL HMUnlockFileEx (HANDLE hFile,
228	DWORD dwReserved,
229	DWORD nNumberOfBytesToLockLow,
230	DWORD nNumberOfBytesToLockHigh,
231	LPOVERLAPPED lpOverlapped);
232
233	DWORD HMWaitForSingleObject (HANDLE hObject,
234	DWORD dwTimeout);
235
236	DWORD HMWaitForSingleObjectEx (HANDLE hObject,
237	DWORD dwTimeout,
238	BOOL fAlertable);
239
240	DWORD HMWaitForMultipleObjects (DWORD cObjects,
241	HANDLE *lphObjects,
242	BOOL fWaitAll,
243	DWORD dwTimeout);
244
245	DWORD HMWaitForMultipleObjectsEx (DWORD cObjects,
246	HANDLE *lphObjects,
247	BOOL fWaitAll,
248	DWORD dwTimeout,
249	BOOL fAlertable);
250
251	DWORD HMMsgWaitForMultipleObjects (DWORD nCount,
252	HANDLE *pHandles,
253	BOOL fWaitAll,
254	DWORD dwMilliseconds,
255	DWORD dwWakeMask);
256
257	BOOL HMDeviceIoControl (HANDLE hDevice,
258	DWORD dwIoControlCode,
259	LPVOID lpInBuffer,
260	DWORD nInBufferSize,
261	LPVOID lpOutBuffer,
262	DWORD nOutBufferSize,
263	LPDWORD lpBytesReturned,
264	LPOVERLAPPED lpOverlapped);
265
266	BOOL HMCancelIo (HANDLE hDevice);
267
268	BOOL HMFlushFileBuffers (HANDLE hObject);
269
270	BOOL HMGetOverlappedResult (HANDLE hObject,
271	LPOVERLAPPED lpOverlapped,
272	LPDWORD lpNumberOfBytesTransferred,
273	BOOL bWait);
274
275	BOOL HMReleaseMutex (HANDLE hObject);
276
277	BOOL HMSetEvent (HANDLE hEvent);
278
279	BOOL HMPulseEvent (HANDLE hEvent);
280
281	BOOL HMResetEvent (HANDLE hEvent);
282
283	HANDLE HMCreateSemaphore (LPSECURITY_ATTRIBUTES lpsa,
284	LONG lInitialCount,
285	LONG lMaximumCount,
286	LPCSTR lpszSemaphoreName);
287
288	HANDLE HMOpenSemaphore (DWORD fdwAccess,
289	BOOL fInheritHandle,
290	LPCSTR lpszSemaphoreName);
291
292	BOOL HMReleaseSemaphore (HANDLE hSemaphore,
293	LONG cReleaseCount,
294	LPLONG lpPreviousCount);
295
296
297	HANDLE HMCreateFileMapping(
298	HFILE hFile, /* [in] Handle of file to map */
299	SECURITY_ATTRIBUTES sa, / [in] Optional security attributes*/
300	DWORD protect, /* [in] Protection for mapping object */
301	DWORD size_high, /* [in] High-order 32 bits of object size */
302	DWORD size_low, /* [in] Low-order 32 bits of object size */
303	LPCSTR name); /* [in] Name of file-mapping object */
304
305	HANDLE HMOpenFileMapping(
306	DWORD access, /* [in] Access mode */
307	BOOL inherit, /* [in] Inherit flag */
308	LPCSTR name ); /* [in] Name of file-mapping object */
309
310	LPVOID HMMapViewOfFileEx (HANDLE hFileMappingObject,
311	DWORD dwDesiredAccess,
312	DWORD dwFileOffsetHigh,
313	DWORD dwFileOffsetLow,
314	DWORD dwNumberOfBytesToMap,
315	LPVOID lpBaseAddress);
316
317	BOOL HMDuplicateHandle(HANDLE srcprocess,
318	HANDLE srchandle,
319	HANDLE destprocess,
320	PHANDLE desthandle,
321	DWORD fdwAccess,
322	BOOL fInherit,
323	DWORD fdwOptions,
324	DWORD fdwOdinOptions = 0);
325
326	#define DUPLICATE_SHARE_DENYNONE 1
327	#define DUPLICATE_SHARE_READ 2
328	#define DUPLICATE_ACCESS_READ 4
329	#define DUPLICATE_ACCESS_WRITE 8
330	#define DUPLICATE_ACCESS_READWRITE (DUPLICATE_ACCESS_WRITE\|DUPLICATE_ACCESS_READ)
331
332	//SvL: Used internally by memory mapped class
333	#define HMDuplicateHandleOdin HMDuplicateHandle
334
335	DWORD HMOpenThreadToken(HANDLE ThreadHandle,
336	DWORD DesiredAccess,
337	DWORD OpenAsSelf,
338	HANDLE *TokenHandle);
339
340	DWORD HMOpenProcessToken(HANDLE ProcessHandle,
341	DWORD DesiredAccess,
342	DWORD dwUserData,
343	HANDLE *TokenHandle);
344
345	BOOL HMCommSetupComm(HANDLE hFile, DWORD dwInQueue, DWORD dwOutQueue);
346
347	BOOL HMCommGetCommState(HANDLE hCommDev, LPDCB lpdcb);
348	BOOL HMCommWaitCommEvent( HANDLE hCommDev,
349	LPDWORD lpfdwEvtMask,
350	LPOVERLAPPED lpo);
351
352	BOOL HMCommGetCommProperties( HANDLE hCommDev,
353	LPCOMMPROP lpcmmp);
354
355	BOOL HMCommGetCommMask( HANDLE hCommDev,
356	LPDWORD lpfdwEvtMask);
357
358	BOOL HMCommSetCommMask( HANDLE hCommDev,
359	DWORD fdwEvtMask);
360
361	BOOL HMCommPurgeComm( HANDLE hCommDev,
362	DWORD fdwAction);
363
364	BOOL HMCommClearCommError( HANDLE hCommDev,
365	LPDWORD lpdwErrors,
366	LPCOMSTAT lpcst);
367
368	BOOL HMCommSetCommState( HANDLE hCommDev,
369	LPDCB lpdcb);
370
371	BOOL HMCommGetCommModemStatus( HANDLE hFile,
372	LPDWORD lpModemStat );
373
374	BOOL HMCommGetCommTimeouts( HANDLE hCommDev,
375	LPCOMMTIMEOUTS lpctmo);
376
377	BOOL HMCommSetCommTimeouts( HANDLE hCommDev,
378	LPCOMMTIMEOUTS lpctmo);
379
380	BOOL HMCommTransmitCommChar( HANDLE hFile,
381	CHAR cChar );
382
383	BOOL HMCommSetCommConfig( HANDLE hCommDev,
384	LPCOMMCONFIG lpCC,
385	DWORD dwSize );
386
387	BOOL HMCommSetCommBreak( HANDLE hFile );
388
389	BOOL HMCommGetCommConfig( HANDLE hCommDev,
390	LPCOMMCONFIG lpCC,
391	LPDWORD lpdwSize );
392
393	BOOL HMCommEscapeCommFunction( HANDLE hFile,
394	UINT dwFunc );
395
396	BOOL HMCommSetupComm( HANDLE hFile,
397	DWORD dwInQueue,
398	DWORD dwOutQueue);
399
400	BOOL HMCommClearCommBreak(HANDLE hFile);
401
402	BOOL HMCommSetDefaultCommConfig( HANDLE hCOM,
403	LPCOMMCONFIG lpCC,
404	DWORD dwSize);
405
406	BOOL HMCommGetDefaultCommConfig( HANDLE hCOM,
407	LPCOMMCONFIG lpCC,
408	LPDWORD lpdwSize);
409
410	HANDLE HMCreateThread(LPSECURITY_ATTRIBUTES lpsa,
411	DWORD cbStack,
412	LPTHREAD_START_ROUTINE lpStartAddr,
413	LPVOID lpvThreadParm,
414	DWORD fdwCreate,
415	LPDWORD lpIDThread,
416	BOOL fFirstThread = FALSE);
417	INT HMGetThreadPriority(HANDLE hThread);
418	DWORD HMSuspendThread(HANDLE hThread);
419	BOOL HMSetThreadPriority(HANDLE hThread, int priority);
420	BOOL HMGetThreadContext(HANDLE hThread, CONTEXT *lpContext);
421	BOOL HMSetThreadContext(HANDLE hThread, const CONTEXT *lpContext);
422	BOOL HMTerminateThread(HANDLE hThread, DWORD exitcode);
423	DWORD HMResumeThread(HANDLE hThread);
424	BOOL HMGetExitCodeThread(HANDLE hThread, LPDWORD lpExitCode);
425	BOOL HMSetThreadTerminated(HANDLE hThread);
426	BOOL HMPeekNamedPipe(HANDLE pHMHandleData,
427	LPVOID lpvBuffer,
428	DWORD cbBuffer,
429	LPDWORD lpcbRead,
430	LPDWORD lpcbAvail,
431	LPDWORD lpcbMessage);
432
433	DWORD HMCreateNamedPipe(LPCTSTR lpName,
434	DWORD dwOpenMode,
435	DWORD dwPipeMode,
436	DWORD nMaxInstances,
437	DWORD nOutBufferSize,
438	DWORD nInBufferSize,
439	DWORD nDefaultTimeOut,
440	LPSECURITY_ATTRIBUTES lpSecurityAttributes);
441
442	BOOL HMConnectNamedPipe(HANDLE hPipe, LPOVERLAPPED lpOverlapped);
443
444	BOOL HMDisconnectNamedPipe(HANDLE hPipe);
445
446	BOOL HMGetNamedPipeHandleState(HANDLE hPipe,
447	LPDWORD lpState,
448	LPDWORD lpCurInstances,
449	LPDWORD lpMaxCollectionCount,
450	LPDWORD lpCollectDataTimeout,
451	LPTSTR lpUserName,
452	DWORD nMaxUserNameSize);
453
454	BOOL HMGetNamedPipeInfo(HANDLE hPipe,
455	LPDWORD lpFlags,
456	LPDWORD lpOutBufferSize,
457	LPDWORD lpInBufferSize,
458	LPDWORD lpMaxInstances);
459
460
461	DWORD HMTransactNamedPipe(HANDLE hPipe,
462	LPVOID lpvWriteBuf,
463	DWORD cbWriteBuf,
464	LPVOID lpvReadBuf,
465	DWORD cbReadBuf,
466	LPDWORD lpcbRead,
467	LPOVERLAPPED lpo);
468
469
470	BOOL HMPeekNamedPipe(HANDLE hPipe,
471	LPVOID lpvBuffer,
472	DWORD cbBuffer,
473	LPDWORD lpcbRead,
474	LPDWORD lpcbAvail,
475	LPDWORD lpcbMessage);
476
477	DWORD HMCreateNamedPipe(LPCTSTR lpName,
478	DWORD dwOpenMode,
479	DWORD dwPipeMode,
480	DWORD nMaxInstances,
481	DWORD nOutBufferSize,
482	DWORD nInBufferSize,
483	DWORD nDefaultTimeOut,
484	void* lpSecurityAttributes);
485
486	BOOL HMConnectNamedPipe(HANDLE hPipe, LPOVERLAPPED lpOverlapped);
487
488	BOOL HMDisconnectNamedPipe(HANDLE hPipe);
489
490	BOOL HMGetNamedPipeHandleState(HANDLE hPipe,
491	LPDWORD lpState,
492	LPDWORD lpCurInstances,
493	LPDWORD lpMaxCollectionCount,
494	LPDWORD lpCollectDataTimeout,
495	LPTSTR lpUserName,
496	DWORD nMaxUserNameSize);
497
498	BOOL HMGetNamedPipeInfo(HANDLE hPipe,
499	LPDWORD lpFlags,
500	LPDWORD lpOutBufferSize,
501	LPDWORD lpInBufferSize,
502	LPDWORD lpMaxInstances);
503
504	DWORD HMTransactNamedPipe(HANDLE hPipe,
505	LPVOID lpvWriteBuf,
506	DWORD cbWriteBuf,
507	LPVOID lpvReadBuf,
508	DWORD cbReadBuf,
509	LPDWORD lpcbRead,
510	LPOVERLAPPED lpo);
511
512	BOOL HMSetNamedPipeHandleState(HANDLE hNamedPipe,
513	LPDWORD lpdwMode,
514	LPDWORD lpcbMaxCollect,
515	LPDWORD lpdwCollectDataTimeout);
516
517	BOOL HMCreatePipe(PHANDLE phRead,
518	PHANDLE phWrite,
519	LPSECURITY_ATTRIBUTES lpsa,
520	DWORD cbPipe);
521
522
523	//Mailslot API
524	HANDLE HMCreateMailslotA(LPCSTR lpName, DWORD nMaxMessageSize,
525	DWORD lReadTimeout,
526	LPSECURITY_ATTRIBUTES lpSecurityAttributes);
527	BOOL HMGetMailslotInfo(HANDLE hMailslot,
528	LPDWORD lpMaxMessageSize,
529	LPDWORD lpNextSize,
530	LPDWORD lpMessageCount,
531	LPDWORD lpReadTimeout);
532	BOOL HMSetMailslotInfo(HANDLE hMailslot,
533	DWORD dwReadTimeout);
534
535	#ifdef __cplusplus__
536	}
537	#endif
538
539	#endif /* _HANDLEMANAGER_H_ */

Note: See TracBrowser for help on using the repository browser.

Download in other formats: