Document that libpq's PQgetResult() should be called after a fatal error
authorBruce Momjian <[email protected]>
Fri, 11 Mar 2011 10:55:13 +0000 (05:55 -0500)
committerBruce Momjian <[email protected]>
Fri, 11 Mar 2011 10:55:13 +0000 (05:55 -0500)
to fully process errors.

doc/src/sgml/libpq.sgml

index 49edc51dbaca20e5f5eacd77450cade4309e3b2e..59b4011b3f6c317608df77864eeb669af9cf7178 100644 (file)
@@ -3846,6 +3846,15 @@ PGresult *PQgetResult(PGconn *conn);
        active and the necessary response data has not yet been read by
        <function>PQconsumeInput</function>.
       </para>
+
+      <note>
+       <para>
+        Even when <function>PQresultStatus</function> indicates a fatal
+        error, <function>PQgetResult</function> should be called until it
+        returns a null pointer to allow <application>libpq</> to
+        process the error information completely.
+       </para>
+      </note>
      </listitem>
     </varlistentry>
    </variablelist>