| Copyright | (c) Esa Ilari Vuokko 2006 |
|---|---|
| License | BSD-style (see the file LICENSE) |
| Maintainer | Esa Ilari Vuokko <ei@vuokko.info> |
| Stability | provisional |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
System.Win32.WindowsString.FileMapping
Description
A collection of FFI declarations for interfacing with Win32 mapped files.
Synopsis
- createFileMapping :: Maybe HANDLE -> ProtectFlags -> DDWORD -> Maybe WindowsString -> IO HANDLE
- mapFile :: WindowsPath -> IO (ForeignPtr a, Int)
- openFileMapping :: FileMapAccess -> BOOL -> Maybe WindowsString -> IO HANDLE
- withMappedFile :: WindowsPath -> Bool -> Maybe Bool -> (Integer -> MappedObject -> IO a) -> IO a
- fILE_SHARE_WRITE :: ShareMode
- mapViewOfFile :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> IO (Ptr a)
- mapViewOfFileEx :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> Ptr a -> IO (Ptr b)
- unmapViewOfFile :: Ptr a -> IO ()
- withMappedArea :: MappedObject -> Integer -> Int -> (Ptr a -> IO b) -> IO b
- fILE_MAP_ALL_ACCESS :: FileMapAccess
- fILE_MAP_COPY :: FileMapAccess
- fILE_MAP_READ :: FileMapAccess
- fILE_MAP_WRITE :: FileMapAccess
- sEC_COMMIT :: ProtectSectionFlags
- sEC_IMAGE :: ProtectSectionFlags
- sEC_NOCACHE :: ProtectSectionFlags
- sEC_RESERVE :: ProtectSectionFlags
- type FileMapAccess = DWORD
- data MappedObject = MappedObject HANDLE HANDLE FileMapAccess
- type ProtectSectionFlags = DWORD
Documentation
createFileMapping :: Maybe HANDLE -> ProtectFlags -> DDWORD -> Maybe WindowsString -> IO HANDLE Source #
mapFile :: WindowsPath -> IO (ForeignPtr a, Int) Source #
Maps file fully and returns ForeignPtr and length of the mapped area. The mapped file is opened read-only and shared reading.
openFileMapping :: FileMapAccess -> BOOL -> Maybe WindowsString -> IO HANDLE Source #
Arguments
| :: WindowsPath | Path |
| -> Bool | Write? (False = read-only) |
| -> Maybe Bool | Sharing mode, no sharing, share read, share read+write |
| -> (Integer -> MappedObject -> IO a) | Action |
| -> IO a |
Opens an existing file and creates mapping object to it.
mapViewOfFile :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> IO (Ptr a) Source #
mapViewOfFileEx :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> Ptr a -> IO (Ptr b) Source #
unmapViewOfFile :: Ptr a -> IO () Source #
Arguments
| :: MappedObject | Mapped object, from withMappedFile |
| -> Integer | Position in file |
| -> Int | Size of mapped area |
| -> (Ptr a -> IO b) | Action |
| -> IO b |
Maps area into memory.
type FileMapAccess = DWORD Source #
data MappedObject Source #
Constructors
| MappedObject HANDLE HANDLE FileMapAccess |
type ProtectSectionFlags = DWORD Source #