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

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >SPI_freetuptable</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="Memory Management"
  16 HREF="spi-memory.html"><LINK
  17 REL="PREVIOUS"
  18 TITLE="SPI_freetuple"
  19 HREF="spi-spi-freetuple.html"><LINK
  20 REL="NEXT"
  21 TITLE="SPI_freeplan"
  22 HREF="spi-spi-freeplan.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-freetuple.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-freetuple.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-freeplan.html"
  74 >Fast Forward</A
  75 ></TD
  76 ><TD
  77 WIDTH="10%"
  78 ALIGN="right"
  79 VALIGN="top"
  80 ><A
  81 HREF="spi-spi-freeplan.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-FREETUPLETABLE"
  93 ></A
  94 >SPI_freetuptable</H1
  95 ><DIV
  96 CLASS="REFNAMEDIV"
  97 ><A
  98 NAME="AEN34446"
  99 ></A
 100 ><H2
 101 >Name</H2
 102 >SPI_freetuptable&nbsp;--&nbsp;free a row set created by <CODE
 103 CLASS="FUNCTION"
 104 >SPI_exec</CODE
 105 > or a similar function</DIV
 106 ><A
 107 NAME="AEN34450"
 108 ></A
 109 ><DIV
 110 CLASS="REFSYNOPSISDIV"
 111 ><A
 112 NAME="AEN34452"
 113 ></A
 114 ><H2
 115 >Synopsis</H2
 116 ><PRE
 117 CLASS="SYNOPSIS"
 118 >void SPI_freetuptable(SPITupleTable * <VAR
 119 CLASS="PARAMETER"
 120 >tuptable</VAR
 121 >)</PRE
 122 ></DIV
 123 ><DIV
 124 CLASS="REFSECT1"
 125 ><A
 126 NAME="AEN34455"
 127 ></A
 128 ><H2
 129 >Description</H2
 130 ><P
 131 >   <CODE
 132 CLASS="FUNCTION"
 133 >SPI_freetuptable</CODE
 134 > frees a row set created by a
 135    prior SPI command execution function, such as
 136    <CODE
 137 CLASS="FUNCTION"
 138 >SPI_exec</CODE
 139 >.  Therefore, this function is usually called
 140    with the global variable <VAR
 141 CLASS="VARNAME"
 142 >SPI_tupletable</VAR
 143 > as
 144    argument.
 145   </P
 146 ><P
 147 >   This function is useful if a SPI procedure needs to execute
 148    multiple commands and does not want to keep the results of earlier
 149    commands around until it ends.  Note that any unfreed row sets will
 150    be freed anyway at <CODE
 151 CLASS="FUNCTION"
 152 >SPI_finish</CODE
 153 >.
 154   </P
 155 ></DIV
 156 ><DIV
 157 CLASS="REFSECT1"
 158 ><A
 159 NAME="AEN34463"
 160 ></A
 161 ><H2
 162 >Arguments</H2
 163 ><P
 164 ></P
 165 ><DIV
 166 CLASS="VARIABLELIST"
 167 ><DL
 168 ><DT
 169 ><TT
 170 CLASS="LITERAL"
 171 >SPITupleTable * <VAR
 172 CLASS="PARAMETER"
 173 >tuptable</VAR
 174 ></TT
 175 ></DT
 176 ><DD
 177 ><P
 178 >      pointer to row set to free
 179      </P
 180 ></DD
 181 ></DL
 182 ></DIV
 183 ></DIV
 184 ><DIV
 185 CLASS="NAVFOOTER"
 186 ><HR
 187 ALIGN="LEFT"
 188 WIDTH="100%"><TABLE
 189 SUMMARY="Footer navigation table"
 190 WIDTH="100%"
 191 BORDER="0"
 192 CELLPADDING="0"
 193 CELLSPACING="0"
 194 ><TR
 195 ><TD
 196 WIDTH="33%"
 197 ALIGN="left"
 198 VALIGN="top"
 199 ><A
 200 HREF="spi-spi-freetuple.html"
 201 ACCESSKEY="P"
 202 >Prev</A
 203 ></TD
 204 ><TD
 205 WIDTH="34%"
 206 ALIGN="center"
 207 VALIGN="top"
 208 ><A
 209 HREF="index.html"
 210 ACCESSKEY="H"
 211 >Home</A
 212 ></TD
 213 ><TD
 214 WIDTH="33%"
 215 ALIGN="right"
 216 VALIGN="top"
 217 ><A
 218 HREF="spi-spi-freeplan.html"
 219 ACCESSKEY="N"
 220 >Next</A
 221 ></TD
 222 ></TR
 223 ><TR
 224 ><TD
 225 WIDTH="33%"
 226 ALIGN="left"
 227 VALIGN="top"
 228 >SPI_freetuple</TD
 229 ><TD
 230 WIDTH="34%"
 231 ALIGN="center"
 232 VALIGN="top"
 233 ><A
 234 HREF="spi-memory.html"
 235 ACCESSKEY="U"
 236 >Up</A
 237 ></TD
 238 ><TD
 239 WIDTH="33%"
 240 ALIGN="right"
 241 VALIGN="top"
 242 >SPI_freeplan</TD
 243 ></TR
 244 ></TABLE
 245 ></DIV
 246 ></BODY
 247 ></HTML
 248 >