From b63e51fe466390812324a5dd4d71f1e68b506699 Mon Sep 17 00:00:00 2001 From: Ross Paterson Date: Fri, 18 Aug 2006 17:03:28 +0000 Subject: [PATCH] fix docs for withC(A)StringLen --- Foreign/C/String.hs | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/Foreign/C/String.hs b/Foreign/C/String.hs index 5654883..8a23c6b 100644 --- a/Foreign/C/String.hs +++ b/Foreign/C/String.hs @@ -168,10 +168,8 @@ newCStringLen = newCAStringLen withCString :: String -> (CString -> IO a) -> IO a withCString = withCAString --- | Marshal a Haskell string into a NUL terminated C string using temporary --- storage. --- --- * the Haskell string may /not/ contain any NUL characters +-- | Marshal a Haskell string into a C string (ie, 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 @@ -309,10 +307,8 @@ withCAString str f = f ptr #endif --- | Marshal a Haskell string into a NUL terminated C string using temporary --- storage. --- --- * the Haskell string may /not/ contain any NUL characters +-- | Marshal a Haskell string into a C string (ie, 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 -- 1.7.10.4