Update PQfree() documentation to be clearer, backpatch to 8.2.X.
authorBruce Momjian
Mon, 19 Feb 2007 22:06:23 +0000 (22:06 +0000)
committerBruce Momjian
Mon, 19 Feb 2007 22:06:23 +0000 (22:06 +0000)
doc/src/sgml/libpq.sgml

index 5b8ef438b36995ff9ca0409e449633fc5d128b79..a7be065ec67d0cf6a240e620aed2afa7e5f59a2d 100644 (file)
@@ -1,4 +1,4 @@
-
+
 
  
   <application>libpq</application> - C Library
@@ -2617,9 +2617,13 @@ void PQfreemem(void *ptr);
    PQescapeBytea,
    PQunescapeBytea,
    and PQnotifies.
-   It is needed by Microsoft Windows, which cannot free memory across
-   DLLs, unless multithreaded DLLs ( in VC6) are used.
-   On other platforms, this function is the same as the standard library function free().
+   It is particularly important that this function, rather than
+   free(), be used on Microsoft Windows.  This is because
+   allocating memory in a DLL and releasing it in the application works
+   only if multithreaded/single-threaded, release/debug, and static/dynamic
+   flags are the same for the DLL and the application.  On non-Microsoft
+   Windows platforms, this function is the same as the standard library
+   function free().