Changeset 2501 for trunk/src/win32k/include/OS2KIO.h

Timestamp:

Jan 22, 2000, 7:21:03 PM (26 years ago)

Author:

bird

Message:

Temporary backup checkin.

File:

• trunk/src/win32k/include/OS2KIO.h (modified) (2 diffs)

trunk/src/win32k/include/OS2KIO.h

@@ -1 @@
-/* $Id: OS2KIO.h,v 1.2 2000-01-17 16:52:25 bird Exp $
+/* $Id: OS2KIO.h,v 1.3 2000-01-22 18:20:58 bird Exp $
  *
- * OS/2 kernel IO, typedefs and macros.
+ * OS/2 kernel IO: prototypes, typedefs and macros.
  *
  * Project Odin Software License can be found in LICENSE.TXT
@@ -10 +10 @@
 #define _OS2KIO_h_
 
-APIRET KRNLCALL IOSftOpen(PSZ pszFilename,
-                          ULONG flOpenFlags,  /* probably similar to DosOpen */
-                          ULONG fsOpenMode,   /* probably similar to DosOpen */
-                          PSFN phFile,
-                          PULONG pulsomething); /* EA? */
-APIRET KRNLCALL IOSftClose(SFN hFile);
-APIRET KRNLCALL IOSftTransPath(PSZ pszPath /* IN and OUT? */);
-APIRET KRNLCALL IOSftReadAt(SFN hFile,
-                            PULONG pulActual,
-                            PVOID pvBuffer,
-                            ULONG flFlags,
-                            ULONG cbBuffer);
-APIRET KRNLCALL IOSftWriteAt(SFN hFile,
-                            PULONG pulActual,
-                            PVOID pvBuffer,
-                            ULONG flFlags,
-                            ULONG cbBuffer);
-/* APIRET KRNLCALL IOSft(1,2,3,4,5); */
+
+/**
+ * Opens a given file.
+ * @returns  NO_ERROR on success. other on error.
+ * @param    pszFilename   Pointer to filename.
+ * @param    flOpenFlags   Open flags. (similar to DosOpen)
+ * @param    fsOpenMode    Open mode flags. (similar to DosOpen)
+ * @param    phFile        Pointer to filehandle.
+ * @param    pulsomething  16-bit near (?) pointer to a variable - unknown. NULL is allowed. EA?
+ */
+APIRET KRNLCALL IOSftOpen(
+    PSZ pszFilename,
+    ULONG flOpenFlags,
+    ULONG fsOpenMode,
+    PSFN phFile,
+    PULONG pulsomething
+    );
+
+
+/**
+ * Closes the specified file.
+ * @returns  NO_ERROR on success. other on error.
+ * @param    hFile      File handle - System File Number.
+ */
+APIRET KRNLCALL IOSftClose(
+    SFN hFile
+    );
+
+
+/**
+ * Probably this function will expand a relative path to a full path.
+ * @returns  NO_ERROR on success. other on error. (?)
+ * @param    pszPath  Pointer to path to expand. Contains the full path upon return. (?)
+ *                    This buffer should probably be of CCHMAXPATH length.
+ */
+APIRET KRNLCALL IOSftTransPath(
+    PSZ pszPath
+    );
+
+
+/**
+ * Read at a given offset in the a file.
+ * @returns  NO_ERROR on success. other on error.
+ * @param    hFile      File handle - System File Number.
+ * @param    pcbActual  Pointer to variable which upon input holds the number
+ *                      of bytes to read, on output the actual number of bytes read.
+ * @param    pvBuffer   Pointer to the read buffer.
+ * @param    flFlags    Read flags?
+ * @param    ulOffset   File offset to read from. (0=start of file)
+ */
+APIRET KRNLCALL IOSftReadAt(
+    SFN hFile,
+    PULONG pcbActual,
+    PVOID pvBuffer,
+    ULONG flFlags,
+    ULONG ulOffset
+    );
+
+
+/**
+ * Write at a given offset in the a file.
+ * @returns  NO_ERROR on success. other on error.
+ * @param    hFile      File handle - System File Number.
+ * @param    pcbActual  Pointer to variable which upon input holds the number
+ *                      of bytes to write, on output the actual number of bytes write.
+ * @param    pvBuffer   Pointer to the write buffer.
+ * @param    flFlags    Read flags?
+ * @param    ulOffset   File offset to write from. (0=start of file)
+ */
+APIRET KRNLCALL IOSftWriteAt(
+    SFN hFile,
+    PULONG pcbActual,
+    PVOID pvBuffer,
+    ULONG flFlags,
+    ULONG ulOffset
+    );
 
 #endif