summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man3/SPI_result_code_string.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:17:33 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:17:33 +0000
commit5e45211a64149b3c659b90ff2de6fa982a5a93ed (patch)
tree739caf8c461053357daa9f162bef34516c7bf452 /doc/src/sgml/man3/SPI_result_code_string.3
parentInitial commit. (diff)
downloadpostgresql-15-5e45211a64149b3c659b90ff2de6fa982a5a93ed.tar.xz
postgresql-15-5e45211a64149b3c659b90ff2de6fa982a5a93ed.zip
Adding upstream version 15.5.upstream/15.5
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/src/sgml/man3/SPI_result_code_string.3')
-rw-r--r--doc/src/sgml/man3/SPI_result_code_string.350
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/src/sgml/man3/SPI_result_code_string.3 b/doc/src/sgml/man3/SPI_result_code_string.3
new file mode 100644
index 0000000..fa76942
--- /dev/null
+++ b/doc/src/sgml/man3/SPI_result_code_string.3
@@ -0,0 +1,50 @@
+'\" t
+.\" Title: SPI_result_code_string
+.\" Author: The PostgreSQL Global Development Group
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2023
+.\" Manual: PostgreSQL 15.5 Documentation
+.\" Source: PostgreSQL 15.5
+.\" Language: English
+.\"
+.TH "SPI_RESULT_CODE_STRING" "3" "2023" "PostgreSQL 15.5" "PostgreSQL 15.5 Documentation"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+SPI_result_code_string \- return error code as string
+.SH "SYNOPSIS"
+.sp
+.nf
+const char * SPI_result_code_string(int \fIcode\fR);
+.fi
+.SH "DESCRIPTION"
+.PP
+\fBSPI_result_code_string\fR
+returns a string representation of the result code returned by various SPI functions or stored in
+\fISPI_result\fR\&.
+.SH "ARGUMENTS"
+.PP
+int \fIcode\fR
+.RS 4
+result code
+.RE
+.SH "RETURN VALUE"
+.PP
+A string representation of the result code\&.