rdelaage
/
postgresql
mirror of https://git.postgresql.org/git/postgresql.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: Document error handling in PGTYPESnumeric_to_long 

The documentation for PGTYPESnumeric_to_long only mentioned errno
being set to indicate overflow but the code also sets errno when
underflow happens.

Reported-by: Aidar Imamov <a.imamov@postgrespro.ru>
Discussion: https://postgr.es/m/eebf0ad50ad4321d65d2d64dd6b7f17d@postgrespro.ru
This commit is contained in:
Daniel Gustafsson 2024-03-25 14:18:39 +01:00
parent b2d6b4c728
commit 68174679fe
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/src/sgml/ecpg.sgml
View File

@ -2390,9 +2390,10 @@ int PGTYPESnumeric_to_long(numeric *nv, long *lp);
The function converts the numeric value from the variable that
<literal>nv</literal> points to into the long integer variable that
<literal>lp</literal> points to. It returns 0 on success and -1 if an error
occurs, including overflow. On overflow, the global variable
occurs, including overflow and underflow. On overflow, the global variable
<literal>errno</literal> will be set to <literal>PGTYPES_NUM_OVERFLOW</literal>
additionally.
and on underflow <literal>errno</literal> will be set to
<literal>PGTYPES_NUM_UNDERFLOW</literal>.
</para>
</listitem>
</varlistentry>