diff options
author | Bruce Momjian <bruce@momjian.us> | 2011-11-10 13:00:51 -0500 |
---|---|---|
committer | Bruce Momjian <bruce@momjian.us> | 2011-11-10 13:00:51 -0500 |
commit | 0b6a1e8a16842f307e34218c24993c7e67644e8c (patch) | |
tree | 19d29fdf042db606e505efa434f713d40bbcf0b4 | |
parent | 7e2c42c74cf71fe884b741dd601da27c357057ff (diff) | |
download | postgresql-0b6a1e8a16842f307e34218c24993c7e67644e8c.tar.gz postgresql-0b6a1e8a16842f307e34218c24993c7e67644e8c.zip |
Document that PQexec() can handle a NULL res pointer just fine.
Backpatch to 9.1.
Mark Hills
-rw-r--r-- | doc/src/sgml/libpq.sgml | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 84a442ed716..08aa3482637 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> @@ -1750,8 +1750,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> |