blob: 6ade9cd7351c711942c7209a84c3e5bbf018c78e (
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
'\" t
.\" Title: SPI_getargtypeid
.\" 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_GETARGTYPEID" "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_getargtypeid \- return the data type OID for an argument of a statement prepared by \fBSPI_prepare\fR
.SH "SYNOPSIS"
.sp
.nf
Oid SPI_getargtypeid(SPIPlanPtr \fIplan\fR, int \fIargIndex\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_getargtypeid\fR
returns the OID representing the type for the
\fIargIndex\fR\*(Aqth argument of a statement prepared by
\fBSPI_prepare\fR\&. First argument is at index zero\&.
.SH "ARGUMENTS"
.PP
SPIPlanPtr \fIplan\fR
.RS 4
prepared statement (returned by
\fBSPI_prepare\fR)
.RE
.PP
int \fIargIndex\fR
.RS 4
zero based index of the argument
.RE
.SH "RETURN VALUE"
.PP
The type OID of the argument at the given index\&. If the
\fIplan\fR
is
NULL
or invalid, or
\fIargIndex\fR
is less than 0 or not less than the number of arguments declared for the
\fIplan\fR,
\fISPI_result\fR
is set to
SPI_ERROR_ARGUMENT
and
InvalidOid
is returned\&.
|
