diff options
| author | Simon Marlow <marlowsd@gmail.com> | 2011-08-25 10:41:43 +0100 |
|---|---|---|
| committer | Simon Marlow <marlowsd@gmail.com> | 2011-08-25 11:12:38 +0100 |
| commit | 65ba73bc3a4622bb05324a933b003923d4b4f5ab (patch) | |
| tree | 5a2f53d338efcaac0faa0ddc70a7446449b4d284 /libraries/base/Foreign | |
| parent | 03e87583133a2d6a95e0e7a22bbfb3d077c91d46 (diff) | |
| download | haskell-65ba73bc3a4622bb05324a933b003923d4b4f5ab.tar.gz | |
Fix documentation for withCWStringLen (#5396)
Diffstat (limited to 'libraries/base/Foreign')
| -rw-r--r-- | libraries/base/Foreign/C/String.hs | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/libraries/base/Foreign/C/String.hs b/libraries/base/Foreign/C/String.hs index f3699160e3..09dd27aca5 100644 --- a/libraries/base/Foreign/C/String.hs +++ b/libraries/base/Foreign/C/String.hs @@ -484,10 +484,9 @@ newCWStringLen str = newArrayLen (charsToCWchars str) withCWString :: String -> (CWString -> IO a) -> IO a withCWString = withArray0 wNUL . charsToCWchars --- | Marshal a Haskell string into a NUL terminated C wide string using --- temporary storage. --- --- * the Haskell string may /not/ contain any NUL characters +-- | Marshal a Haskell string into a C wide string (i.e. wide +-- character array) in temporary storage, with explicit length +-- information. -- -- * the memory is freed when the subcomputation terminates (either -- normally or via an exception), so the pointer to the temporary |