File: spi-spi-freeplan.html

package info (click to toggle)
pgadmin3 1.4.3-2
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 29,796 kB
  • ctags: 10,758
  • sloc: cpp: 55,356; sh: 6,164; ansic: 1,520; makefile: 576; sql: 482; xml: 100; perl: 18
file content (46 lines) | stat: -rw-r--r-- 1,986 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>SPI_freeplan</title>
<link rel="stylesheet" href="stylesheet.css" type="text/css">
<link rev="made" href="pgsql-docs@postgresql.org">
<meta name="generator" content="DocBook XSL Stylesheets V1.70.0">
<link rel="start" href="index.html" title="PostgreSQL 8.1.4 Documentation">
<link rel="up" href="spi-memory.html" title="40.3.Memory Management">
<link rel="prev" href="spi-spi-freetupletable.html" title="SPI_freetuptable">
<link rel="next" href="spi-visibility.html" title="40.4.Visibility of Data Changes">
<link rel="copyright" href="ln-legalnotice.html" title="Legal Notice">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
<a name="spi-spi-freeplan"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>SPI_freeplan &#8212; free a previously saved plan</p>
</div>
<a name="id739883"></a><div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">int SPI_freeplan(void *<em class="parameter"><code>plan</code></em>)</pre>
</div>
<div class="refsect1" lang="en">
<a name="id739902"></a><h2>Description</h2>
<p>   <code class="function">SPI_freeplan</code> releases a command execution plan
   previously returned by <code class="function">SPI_prepare</code> or saved by
   <code class="function">SPI_saveplan</code>.
  </p>
</div>
<div class="refsect1" lang="en">
<a name="id739930"></a><h2>Arguments</h2>
<div class="variablelist"><dl>
<dt><span class="term"><code class="literal">void * <em class="parameter"><code>plan</code></em></code></span></dt>
<dd><p>      pointer to plan to free
     </p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id739952"></a><h2>Return Value</h2>
<p>   <code class="symbol">SPI_ERROR_ARGUMENT</code> if <em class="parameter"><code>plan</code></em>
   is <code class="symbol">NULL</code>.
  </p>
</div>
</div></body>
</html>