General Bug Report: Documentation problem

Unprivileged user <nobody>

From: Unprivileged user <nobody>
To: pgsql-bugs@postgresql.org
Date: 1999-04-17T09:06:33Z
Lists: pgsql-bugs
============================================================================
                        POSTGRESQL BUG REPORT TEMPLATE
============================================================================


Your name               : Dan Merillat
Your email address      : Dan@merillat.org

Category                : install: other
Severity                : non-critical

Summary: Documentation problem

System Configuration
--------------------
  Operating System   : N/A

  PostgreSQL version : 6.3

  Compiler used      : N/A

Hardware:
---------
N/A

Versions of other tools:
------------------------
N/A

--------------------------------------------------------------------------

Problem Description:
--------------------
libpq documentation has a few errors.  Most notably, the reccomended style of error handling.
psuedocode: res=PQexec(conn, "error-prone-statement"); if (PQresultStatus(res) != PGRES_TUPLES_OK) { do_error_code(); }
This is actually incorrect, since on error, PQexec returns null, so PQresultStatus (which I can't find documented)  derefrences a null pointer.
Correct example code would be res=PQexec(conn, "error-prone-statment"); if (!res) { printf("PQexec(): %s\n", PQerrorMessage(conn)); exit(1) }

If nobody else is working on the documentation reply to me, and I'll submit diffs.

--Dan


--------------------------------------------------------------------------

Test Case:
----------


--------------------------------------------------------------------------

Solution:
---------


--------------------------------------------------------------------------