Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 712dd95

Browse files
committed
More libpq documentation adjustments from Leslie S Satenstein, reviewed
by Robert Haas.
1 parent a5a02a7 commit 712dd95

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

doc/src/sgml/libpq.sgml

+7-15
Original file line numberDiff line numberDiff line change
@@ -972,8 +972,8 @@ PQconninfoOption *PQconninfoParse(const char *conninfo, char **errmsg);
972972
If <literal>errmsg</> is not <symbol>NULL</>, then <literal>*errmsg</> is set
973973
to <symbol>NULL</> on success, else to a <function>malloc</>'d error string explaining
974974
the problem. (It is also possible for <literal>*errmsg</> to be
975-
set to <symbol>NULL</> even when <symbol>NULL</> is returned; this indicates an out-of-memory
976-
situation.)
975+
set to <symbol>NULL</> and the function to return <symbol>NULL</>;
976+
this indicates an out-of-memory condition.)
977977
</para>
978978

979979
<para>
@@ -1352,7 +1352,7 @@ ConnStatusType PQstatus(const PGconn *conn);
13521352
<para>
13531353
See the entry for <function>PQconnectStartParams</>, <function>PQconnectStart</>
13541354
and <function>PQconnectPoll</> with regards to other status codes that
1355-
might be seen.
1355+
might be returned.
13561356
</para>
13571357
</listitem>
13581358
</varlistentry>
@@ -3163,23 +3163,15 @@ Oid PQoidValue(const PGresult *res);
31633163

31643164
<listitem>
31653165
<para>
3166-
Returns a string with the OID of the inserted row, if the
3167-
<acronym>SQL</acronym> command was an <command>INSERT</command>
3168-
that inserted exactly one row, or a <command>EXECUTE</command> of
3169-
a prepared statement consisting of a suitable
3170-
<command>INSERT</command>. (The string will be <literal>0</> if
3171-
the <command>INSERT</command> did not insert exactly one row, or
3172-
if the target table does not have OIDs.) If the command was not
3173-
an <command>INSERT</command>, returns an empty string.
3166+
This function is deprecated in favor of
3167+
<function>PQoidValue</function> and is not thread-safe.
3168+
It returns a string with the OID of the inserted row, while
3169+
<function>PQoidValue</function> returns the OID value.
31743170
<synopsis>
31753171
char *PQoidStatus(const PGresult *res);
31763172
</synopsis>
31773173
</para>
31783174

3179-
<para>
3180-
This function is deprecated in favor of
3181-
<function>PQoidValue</function>. It is not thread-safe.
3182-
</para>
31833175
</listitem>
31843176
</varlistentry>
31853177
</variablelist>

0 commit comments

Comments
 (0)