System.Win32.WindowsString.FileMapping

Win32-2.14.0.0: A binding to Windows Win32 API.

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

- mapFile :: WindowsPath -> IO (ForeignPtr a, Int)
- withMappedFile :: WindowsPath -> Bool -> Maybe Bool -> (Integer -> MappedObject -> IO a) -> IO a
- createFileMapping :: Maybe HANDLE -> ProtectFlags -> DDWORD -> Maybe WindowsString -> IO HANDLE
- openFileMapping :: FileMapAccess -> BOOL -> Maybe WindowsString -> IO HANDLE
- fILE_SHARE_WRITE :: ShareMode
- data MappedObject = MappedObject HANDLE HANDLE FileMapAccess
- withMappedArea :: MappedObject -> Integer -> Int -> (Ptr a -> IO b) -> IO b
- type ProtectSectionFlags = DWORD
- sEC_COMMIT :: ProtectSectionFlags
- sEC_IMAGE :: ProtectSectionFlags
- sEC_NOCACHE :: ProtectSectionFlags
- sEC_RESERVE :: ProtectSectionFlags
- type FileMapAccess = DWORD
- fILE_MAP_ALL_ACCESS :: FileMapAccess
- fILE_MAP_COPY :: FileMapAccess
- fILE_MAP_READ :: FileMapAccess
- fILE_MAP_WRITE :: FileMapAccess
- mapViewOfFileEx :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> Ptr a -> IO (Ptr b)
- mapViewOfFile :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> IO (Ptr a)
- unmapViewOfFile :: Ptr a -> IO ()

# Documentation

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.

withMappedFile 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.

createFileMapping :: Maybe HANDLE -> ProtectFlags -> DDWORD -> Maybe WindowsString -> IO HANDLE Source #

openFileMapping :: FileMapAccess -> BOOL -> Maybe WindowsString -> IO HANDLE Source #

fILE_SHARE_WRITE :: ShareMode Source #

data MappedObject Source #

Constructors

MappedObject HANDLE HANDLE FileMapAccess |

withMappedArea 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 ProtectSectionFlags = DWORD Source #

sEC_COMMIT :: ProtectSectionFlags Source #

sEC_IMAGE :: ProtectSectionFlags Source #

sEC_NOCACHE :: ProtectSectionFlags Source #

sEC_RESERVE :: ProtectSectionFlags Source #

type FileMapAccess = DWORD Source #

fILE_MAP_ALL_ACCESS :: FileMapAccess Source #

fILE_MAP_COPY :: FileMapAccess Source #

fILE_MAP_READ :: FileMapAccess Source #

fILE_MAP_WRITE :: FileMapAccess Source #

mapViewOfFileEx :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> Ptr a -> IO (Ptr b) Source #

mapViewOfFile :: HANDLE -> FileMapAccess -> DDWORD -> SIZE_T -> IO (Ptr a) Source #

unmapViewOfFile :: Ptr a -> IO () Source #