diff options
| author | Peter Eisentraut <peter_e@gmx.net> | 2017-08-30 22:16:50 -0400 |
|---|---|---|
| committer | Peter Eisentraut <peter_e@gmx.net> | 2017-10-04 22:14:21 -0400 |
| commit | 036166f26e00ab3286ef29a6519525d6291fdfd7 (patch) | |
| tree | 2efdc8207d5cfef2dfe32db174741418647bf10c /doc/src | |
| parent | 582bbcf37fb45ea2e6a851bf9a3c7d7364c7ad32 (diff) | |
Document and use SPI_result_code_string()
A lot of semi-internal code just prints out numeric SPI error codes,
which is not very helpful. We already have an API function to convert
the codes to a string, so let's make more use of that.
Reviewed-by: Michael Paquier <michael.paquier@gmail.com>
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/spi.sgml | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/src/sgml/spi.sgml b/doc/src/sgml/spi.sgml index 31535a307d1..3594f9dce1d 100644 --- a/doc/src/sgml/spi.sgml +++ b/doc/src/sgml/spi.sgml @@ -3546,6 +3546,59 @@ char * SPI_getnspname(Relation <parameter>rel</parameter>) </refsect1> </refentry> +<refentry id="spi-spi-result-code-string"> + <indexterm><primary>SPI_result_code_string</primary></indexterm> + + <refmeta> + <refentrytitle>SPI_result_code_string</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>SPI_result_code_string</refname> + <refpurpose>return error code as string</refpurpose> + </refnamediv> + + <refsynopsisdiv> +<synopsis> +const char * SPI_result_code_string(int <parameter>code</parameter>); +</synopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para> + <function>SPI_result_code_string</function> returns a string representation + of the result code returned by various SPI functions or stored + in <varname>SPI_result</varname>. + </para> + </refsect1> + + <refsect1> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term><literal>int <parameter>code</parameter></literal></term> + <listitem> + <para> + result code + </para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para> + A string representation of the result code. + </para> + </refsect1> +</refentry> + </sect1> <sect1 id="spi-memory"> |