I686LINUX/util/I686LINUX/doc/postgresql/html/spi-spi-cursor-fetch.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >SPI_cursor_fetch</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 Functions"
  16 HREF="spi.html#SPI-INTERFACE"><LINK
  17 REL="PREVIOUS"
  18 TITLE="SPI_cursor_find"
  19 HREF="spi-spi-cursor-find.html"><LINK
  20 REL="NEXT"
  21 TITLE="SPI_cursor_move"
  22 HREF="spi-spi-cursor-move.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-cursor-find.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-cursor-find.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-cursor-move.html"
  74 >Fast Forward</A
  75 ></TD
  76 ><TD
  77 WIDTH="10%"
  78 ALIGN="right"
  79 VALIGN="top"
  80 ><A
  81 HREF="spi-spi-cursor-move.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-CURSOR-FETCH"
  93 ></A
  94 >SPI_cursor_fetch</H1
  95 ><DIV
  96 CLASS="REFNAMEDIV"
  97 ><A
  98 NAME="AEN33646"
  99 ></A
 100 ><H2
 101 >Name</H2
 102 >SPI_cursor_fetch&nbsp;--&nbsp;fetch some rows from a cursor</DIV
 103 ><A
 104 NAME="AEN33649"
 105 ></A
 106 ><DIV
 107 CLASS="REFSYNOPSISDIV"
 108 ><A
 109 NAME="AEN33651"
 110 ></A
 111 ><H2
 112 >Synopsis</H2
 113 ><PRE
 114 CLASS="SYNOPSIS"
 115 >void SPI_cursor_fetch(Portal <VAR
 116 CLASS="PARAMETER"
 117 >portal</VAR
 118 >, bool <VAR
 119 CLASS="PARAMETER"
 120 >forward</VAR
 121 >, int <VAR
 122 CLASS="PARAMETER"
 123 >count</VAR
 124 >)</PRE
 125 ></DIV
 126 ><DIV
 127 CLASS="REFSECT1"
 128 ><A
 129 NAME="AEN33656"
 130 ></A
 131 ><H2
 132 >Description</H2
 133 ><P
 134 >   <CODE
 135 CLASS="FUNCTION"
 136 >SPI_cursor_fetch</CODE
 137 > fetches some rows from a
 138    cursor.  This is equivalent to the SQL command <TT
 139 CLASS="COMMAND"
 140 >FETCH</TT
 141 >.
 142   </P
 143 ></DIV
 144 ><DIV
 145 CLASS="REFSECT1"
 146 ><A
 147 NAME="AEN33661"
 148 ></A
 149 ><H2
 150 >Arguments</H2
 151 ><P
 152 ></P
 153 ><DIV
 154 CLASS="VARIABLELIST"
 155 ><DL
 156 ><DT
 157 ><TT
 158 CLASS="LITERAL"
 159 >Portal <VAR
 160 CLASS="PARAMETER"
 161 >portal</VAR
 162 ></TT
 163 ></DT
 164 ><DD
 165 ><P
 166 >      portal containing the cursor
 167      </P
 168 ></DD
 169 ><DT
 170 ><TT
 171 CLASS="LITERAL"
 172 >bool <VAR
 173 CLASS="PARAMETER"
 174 >forward</VAR
 175 ></TT
 176 ></DT
 177 ><DD
 178 ><P
 179 >      true for fetch forward, false for fetch backward
 180      </P
 181 ></DD
 182 ><DT
 183 ><TT
 184 CLASS="LITERAL"
 185 >int <VAR
 186 CLASS="PARAMETER"
 187 >count</VAR
 188 ></TT
 189 ></DT
 190 ><DD
 191 ><P
 192 >      maximum number of rows to fetch
 193      </P
 194 ></DD
 195 ></DL
 196 ></DIV
 197 ></DIV
 198 ><DIV
 199 CLASS="REFSECT1"
 200 ><A
 201 NAME="AEN33682"
 202 ></A
 203 ><H2
 204 >Return Value</H2
 205 ><P
 206 >   <VAR
 207 CLASS="VARNAME"
 208 >SPI_processed</VAR
 209 > and
 210    <VAR
 211 CLASS="VARNAME"
 212 >SPI_tuptable</VAR
 213 > are set as in
 214    <CODE
 215 CLASS="FUNCTION"
 216 >SPI_exec</CODE
 217 > if successful.
 218   </P
 219 ></DIV
 220 ><DIV
 221 CLASS="NAVFOOTER"
 222 ><HR
 223 ALIGN="LEFT"
 224 WIDTH="100%"><TABLE
 225 SUMMARY="Footer navigation table"
 226 WIDTH="100%"
 227 BORDER="0"
 228 CELLPADDING="0"
 229 CELLSPACING="0"
 230 ><TR
 231 ><TD
 232 WIDTH="33%"
 233 ALIGN="left"
 234 VALIGN="top"
 235 ><A
 236 HREF="spi-spi-cursor-find.html"
 237 ACCESSKEY="P"
 238 >Prev</A
 239 ></TD
 240 ><TD
 241 WIDTH="34%"
 242 ALIGN="center"
 243 VALIGN="top"
 244 ><A
 245 HREF="index.html"
 246 ACCESSKEY="H"
 247 >Home</A
 248 ></TD
 249 ><TD
 250 WIDTH="33%"
 251 ALIGN="right"
 252 VALIGN="top"
 253 ><A
 254 HREF="spi-spi-cursor-move.html"
 255 ACCESSKEY="N"
 256 >Next</A
 257 ></TD
 258 ></TR
 259 ><TR
 260 ><TD
 261 WIDTH="33%"
 262 ALIGN="left"
 263 VALIGN="top"
 264 >SPI_cursor_find</TD
 265 ><TD
 266 WIDTH="34%"
 267 ALIGN="center"
 268 VALIGN="top"
 269 ><A
 270 HREF="spi.html#SPI-INTERFACE"
 271 ACCESSKEY="U"
 272 >Up</A
 273 ></TD
 274 ><TD
 275 WIDTH="33%"
 276 ALIGN="right"
 277 VALIGN="top"
 278 >SPI_cursor_move</TD
 279 ></TR
 280 ></TABLE
 281 ></DIV
 282 ></BODY
 283 ></HTML
 284 >