Win32-2.6.1.0: A binding to part of the Win32 library

Copyright2013 shelarcy
LicenseBSD-style
Maintainershelarcy@gmail.com
StabilityProvisional
PortabilityNon-portable (Win32 API)
Safe HaskellSafe
LanguageHaskell2010

System.Win32.String

Description

Utilities for primitive marshalling of Windows' C strings.

Synopsis

Documentation

type LPSTR = Ptr CChar #

type LPCSTR = LPSTR #

type TCHAR = CWchar #

type LPTSTR = Ptr TCHAR #

withTString :: String -> (LPTSTR -> IO a) -> IO a #

withTStringLen :: String -> ((LPTSTR, Int) -> IO a) -> IO a #

withTStringBuffer :: Int -> (LPTSTR -> IO a) -> IO a #

Marshal a dummy Haskell string into a NUL terminated C wide string using temporary storage.

  • the Haskell string is created by length parameter. And the Haskell string contains only NUL characters.
  • the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.

withTStringBufferLen :: Int -> ((LPTSTR, Int) -> IO a) -> IO a #

Marshal a dummy Haskell string into a C wide string (i.e. wide character array) in temporary storage, with explicit length information.

  • the Haskell string is created by length parameter. And the Haskell string contains only NUL characters.
  • the memory is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this.