I686LINUX/util/I686LINUX/doc/postgresql/html/spi-spi-fnumber.html

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