Current File : //proc/thread-self/root/proc/self/root/opt/alt/postgresql11/usr/share/man/man3/SPI_fnumber.3
'\" t
.\" Title: SPI_fnumber
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 2017-11-06
.\" Manual: PostgreSQL 9.2.24 Documentation
.\" Source: PostgreSQL 9.2.24
.\" Language: English
.\"
.TH "SPI_FNUMBER" "3" "2017-11-06" "PostgreSQL 9.2.24" "PostgreSQL 9.2.24 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_fnumber \- determine the column number for the specified column name
.\" SPI_fnumber
.SH "SYNOPSIS"
.sp
.nf
int SPI_fnumber(TupleDesc \fIrowdesc\fR, const char * \fIcolname\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_fnumber\fR
returns the column number for the column with the specified name\&.
.PP
If
\fIcolname\fR
refers to a system column (e\&.g\&.,
oid) then the appropriate negative column number will be returned\&. The caller should be careful to test the return value for exact equality to
SPI_ERROR_NOATTRIBUTE
to detect an error; testing the result for less than or equal to 0 is not correct unless system columns should be rejected\&.
.SH "ARGUMENTS"
.PP
TupleDesc \fIrowdesc\fR
.RS 4
input row description
.RE
.PP
const char * \fIcolname\fR
.RS 4
column name
.RE
.SH "RETURN VALUE"
.PP
Column number (count starts at 1), or
SPI_ERROR_NOATTRIBUTE
if the named column was not found\&.
Mini Shell