summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man3/SPI_result_code_string.3
blob: 4780846e99eb4afbf96a42e0ce78d6f9d986e401 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
'\" t
.\"     Title: SPI_result_code_string
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2024
.\"    Manual: PostgreSQL 15.6 Documentation
.\"    Source: PostgreSQL 15.6
.\"  Language: English
.\"
.TH "SPI_RESULT_CODE_STRING" "3" "2024" "PostgreSQL 15.6" "PostgreSQL 15.6 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\&.