From: Bruce Momjian <bruce@momjian.us>
Date: Thu, 10 Nov 2011 18:00:44 +0000 (-0500)
Subject: Document that PQexec() can handle a NULL res pointer just fine.
X-Git-Tag: REL9_2_BETA1~843
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d5873b635989e0b780c1c9f07139dfebf0f5e546;p=postgresql

Document that PQexec() can handle a NULL res pointer just fine.

Backpatch to 9.1.

Mark Hills
---

diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
index f2f67e20ff..3d5f98ba2a 100644
--- a/doc/src/sgml/libpq.sgml
+++ b/doc/src/sgml/libpq.sgml
@@ -62,7 +62,7 @@
    return a non-null object pointer, unless perhaps there is too
    little memory even to allocate the <structname>PGconn</> object.
    The <function>PQstatus</> function should be called to check
-   whether a connection was successfully made before queries are sent
+   the return value for a successful connection before queries are sent
    via the connection object.
 
    <warning>
@@ -1754,8 +1754,10 @@ PGresult *PQexec(PGconn *conn, const char *command);
         Returns a <structname>PGresult</structname> pointer or possibly a null
         pointer.  A non-null pointer will generally be returned except in
         out-of-memory conditions or serious errors such as inability to send
-        the command to the server.  If a null pointer is returned, it should
-        be treated like a <symbol>PGRES_FATAL_ERROR</symbol> result.  Use
+        the command to the server.  The <function>PQresultStatus</> function
+        should be called to check the return value for any errors (including
+        the value of a null pointer, in which case it will return
+        <symbol>PGRES_FATAL_ERROR</symbol>).  Use
         <function>PQerrorMessage</function> to get more information about such
         errors.
        </para>