← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/postgresql-9.1/oneiric-security

« back to all changes in this revision

Viewing changes to doc/src/sgml/html/spi-spi-fnumber.html

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-11 10:41:53 UTC
  • Revision ID: james.westby@ubuntu.com-20110511104153-psbh2o58553fv1m0
Tags: upstream-9.1~beta1
Import upstream version 9.1~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/html/spi-spi-fnumber.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 
2
<HTML
 
3
><HEAD
 
4
><TITLE
 
5
>SPI_fnumber</TITLE
 
6
><META
 
7
NAME="GENERATOR"
 
8
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 
9
REV="MADE"
 
10
HREF="mailto:pgsql-docs@postgresql.org"><LINK
 
11
REL="HOME"
 
12
TITLE="PostgreSQL 9.1beta1 Documentation"
 
13
HREF="index.html"><LINK
 
14
REL="UP"
 
15
TITLE="Interface Support Functions"
 
16
HREF="spi-interface-support.html"><LINK
 
17
REL="PREVIOUS"
 
18
TITLE="SPI_fname"
 
19
HREF="spi-spi-fname.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="SPI_getvalue"
 
22
HREF="spi-spi-getvalue.html"><LINK
 
23
REL="STYLESHEET"
 
24
TYPE="text/css"
 
25
HREF="stylesheet.css"><META
 
26
HTTP-EQUIV="Content-Type"
 
27
CONTENT="text/html; charset=ISO-8859-1"><META
 
28
NAME="creation"
 
29
CONTENT="2011-04-27T21:20:33"></HEAD
 
30
><BODY
 
31
CLASS="REFENTRY"
 
32
><DIV
 
33
CLASS="NAVHEADER"
 
34
><TABLE
 
35
SUMMARY="Header navigation table"
 
36
WIDTH="100%"
 
37
BORDER="0"
 
38
CELLPADDING="0"
 
39
CELLSPACING="0"
 
40
><TR
 
41
><TH
 
42
COLSPAN="5"
 
43
ALIGN="center"
 
44
VALIGN="bottom"
 
45
><A
 
46
HREF="index.html"
 
47
>PostgreSQL 9.1beta1 Documentation</A
 
48
></TH
 
49
></TR
 
50
><TR
 
51
><TD
 
52
WIDTH="10%"
 
53
ALIGN="left"
 
54
VALIGN="top"
 
55
><A
 
56
TITLE="SPI_fname"
 
57
HREF="spi-spi-fname.html"
 
58
ACCESSKEY="P"
 
59
>Prev</A
 
60
></TD
 
61
><TD
 
62
WIDTH="10%"
 
63
ALIGN="left"
 
64
VALIGN="top"
 
65
><A
 
66
TITLE="SPI_fname"
 
67
HREF="spi-spi-fname.html"
 
68
>Fast Backward</A
 
69
></TD
 
70
><TD
 
71
WIDTH="60%"
 
72
ALIGN="center"
 
73
VALIGN="bottom"
 
74
></TD
 
75
><TD
 
76
WIDTH="10%"
 
77
ALIGN="right"
 
78
VALIGN="top"
 
79
><A
 
80
TITLE="SPI_getvalue"
 
81
HREF="spi-spi-getvalue.html"
 
82
>Fast Forward</A
 
83
></TD
 
84
><TD
 
85
WIDTH="10%"
 
86
ALIGN="right"
 
87
VALIGN="top"
 
88
><A
 
89
TITLE="SPI_getvalue"
 
90
HREF="spi-spi-getvalue.html"
 
91
ACCESSKEY="N"
 
92
>Next</A
 
93
></TD
 
94
></TR
 
95
></TABLE
 
96
><HR
 
97
ALIGN="LEFT"
 
98
WIDTH="100%"></DIV
 
99
><H1
 
100
><A
 
101
NAME="SPI-SPI-FNUMBER"
 
102
></A
 
103
>SPI_fnumber</H1
 
104
><DIV
 
105
CLASS="REFNAMEDIV"
 
106
><A
 
107
NAME="AEN58566"
 
108
></A
 
109
><H2
 
110
>Name</H2
 
111
>SPI_fnumber&nbsp;--&nbsp;determine the column number for the specified column name</DIV
 
112
><DIV
 
113
CLASS="REFSYNOPSISDIV"
 
114
><A
 
115
NAME="AEN58571"
 
116
></A
 
117
><H2
 
118
>Synopsis</H2
 
119
><PRE
 
120
CLASS="SYNOPSIS"
 
121
>int SPI_fnumber(TupleDesc <TT
 
122
CLASS="PARAMETER"
 
123
>rowdesc</TT
 
124
>, const char * <TT
 
125
CLASS="PARAMETER"
 
126
>colname</TT
 
127
>)</PRE
 
128
></DIV
 
129
><DIV
 
130
CLASS="REFSECT1"
 
131
><A
 
132
NAME="AEN58575"
 
133
></A
 
134
><H2
 
135
>Description</H2
 
136
><P
 
137
>   <CODE
 
138
CLASS="FUNCTION"
 
139
>SPI_fnumber</CODE
 
140
> returns the column number for the
 
141
   column with the specified name.
 
142
  </P
 
143
><P
 
144
>   If <TT
 
145
CLASS="PARAMETER"
 
146
>colname</TT
 
147
> refers to a system column (e.g.,
 
148
   <TT
 
149
CLASS="LITERAL"
 
150
>oid</TT
 
151
>) then the appropriate negative column number will
 
152
   be returned.  The caller should be careful to test the return value
 
153
   for exact equality to <TT
 
154
CLASS="SYMBOL"
 
155
>SPI_ERROR_NOATTRIBUTE</TT
 
156
> to
 
157
   detect an error; testing the result for less than or equal to 0 is
 
158
   not correct unless system columns should be rejected.
 
159
  </P
 
160
></DIV
 
161
><DIV
 
162
CLASS="REFSECT1"
 
163
><A
 
164
NAME="AEN58583"
 
165
></A
 
166
><H2
 
167
>Arguments</H2
 
168
><P
 
169
></P
 
170
><DIV
 
171
CLASS="VARIABLELIST"
 
172
><DL
 
173
><DT
 
174
><TT
 
175
CLASS="LITERAL"
 
176
>TupleDesc <TT
 
177
CLASS="PARAMETER"
 
178
>rowdesc</TT
 
179
></TT
 
180
></DT
 
181
><DD
 
182
><P
 
183
>      input row description
 
184
     </P
 
185
></DD
 
186
><DT
 
187
><TT
 
188
CLASS="LITERAL"
 
189
>const char * <TT
 
190
CLASS="PARAMETER"
 
191
>colname</TT
 
192
></TT
 
193
></DT
 
194
><DD
 
195
><P
 
196
>      column name
 
197
     </P
 
198
></DD
 
199
></DL
 
200
></DIV
 
201
></DIV
 
202
><DIV
 
203
CLASS="REFSECT1"
 
204
><A
 
205
NAME="AEN58598"
 
206
></A
 
207
><H2
 
208
>Return Value</H2
 
209
><P
 
210
>   Column number (count starts at 1), or
 
211
   <TT
 
212
CLASS="SYMBOL"
 
213
>SPI_ERROR_NOATTRIBUTE</TT
 
214
> if the named column was not
 
215
   found.
 
216
  </P
 
217
></DIV
 
218
><DIV
 
219
CLASS="NAVFOOTER"
 
220
><HR
 
221
ALIGN="LEFT"
 
222
WIDTH="100%"><TABLE
 
223
SUMMARY="Footer navigation table"
 
224
WIDTH="100%"
 
225
BORDER="0"
 
226
CELLPADDING="0"
 
227
CELLSPACING="0"
 
228
><TR
 
229
><TD
 
230
WIDTH="33%"
 
231
ALIGN="left"
 
232
VALIGN="top"
 
233
><A
 
234
HREF="spi-spi-fname.html"
 
235
ACCESSKEY="P"
 
236
>Prev</A
 
237
></TD
 
238
><TD
 
239
WIDTH="34%"
 
240
ALIGN="center"
 
241
VALIGN="top"
 
242
><A
 
243
HREF="index.html"
 
244
ACCESSKEY="H"
 
245
>Home</A
 
246
></TD
 
247
><TD
 
248
WIDTH="33%"
 
249
ALIGN="right"
 
250
VALIGN="top"
 
251
><A
 
252
HREF="spi-spi-getvalue.html"
 
253
ACCESSKEY="N"
 
254
>Next</A
 
255
></TD
 
256
></TR
 
257
><TR
 
258
><TD
 
259
WIDTH="33%"
 
260
ALIGN="left"
 
261
VALIGN="top"
 
262
>SPI_fname</TD
 
263
><TD
 
264
WIDTH="34%"
 
265
ALIGN="center"
 
266
VALIGN="top"
 
267
><A
 
268
HREF="spi-interface-support.html"
 
269
ACCESSKEY="U"
 
270
>Up</A
 
271
></TD
 
272
><TD
 
273
WIDTH="33%"
 
274
ALIGN="right"
 
275
VALIGN="top"
 
276
>SPI_getvalue</TD
 
277
></TR
 
278
></TABLE
 
279
></DIV
 
280
></BODY
 
281
></HTML
 
282
>
 
 
b'\\ No newline at end of file'