aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBruce Momjian <bruce@momjian.us>2007-02-19 22:06:30 +0000
committerBruce Momjian <bruce@momjian.us>2007-02-19 22:06:30 +0000
commitc2039e4477c25f2cfcc184d7653e35abeaeeecd3 (patch)
treec5bb9c1091b6ca15975611cbc738a0ebb1a2b84d
parent7c2e6f31be8b3a659bbb4292d4ee5cb3a038a59f (diff)
downloadpostgresql-c2039e4477c25f2cfcc184d7653e35abeaeeecd3.tar.gz
postgresql-c2039e4477c25f2cfcc184d7653e35abeaeeecd3.zip
Update PQfree() documentation to be clearer, backpatch to 8.2.X.
-rw-r--r--doc/src/sgml/libpq.sgml12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index 6d3c1f4649d..bba83920d9b 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.220.2.5 2007/02/06 03:05:00 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/libpq.sgml,v 1.220.2.6 2007/02/19 22:06:30 momjian Exp $ -->
<chapter id="libpq">
<title><application>libpq</application> - C Library</title>
@@ -2611,9 +2611,13 @@ void PQfreemem(void *ptr);
<function>PQescapeBytea</function>,
<function>PQunescapeBytea</function>,
and <function>PQnotifies</function>.
- It is needed by Microsoft Windows, which cannot free memory across
- DLLs, unless multithreaded DLLs (<option>/MD</option> in VC6) are used.
- On other platforms, this function is the same as the standard library function <function>free()</>.
+ It is particularly important that this function, rather than
+ <function>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 <function>free()</>.
</para>
</listitem>
</varlistentry>