File: spi-spi-copytuple.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 (47 lines) | stat: -rw-r--r-- 2,072 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
47
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>SPI_copytuple</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-pfree.html" title="SPI_pfree">
<link rel="next" href="spi-spi-returntuple.html" title="SPI_returntuple">
<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-copytuple"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>SPI_copytuple &#8212; make a copy of a row in the upper executor context</p>
</div>
<a name="id739109"></a><div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">HeapTuple SPI_copytuple(HeapTuple <em class="parameter"><code>row</code></em>)</pre>
</div>
<div class="refsect1" lang="en">
<a name="id739128"></a><h2>Description</h2>
<p>   <code class="function">SPI_copytuple</code> makes a copy of a row in the
   upper executor context.  This is normally used to return a modified
   row from a trigger.  In a function declared to return a composite
   type, use <code class="function">SPI_returntuple</code> instead.
  </p>
</div>
<div class="refsect1" lang="en">
<a name="id739151"></a><h2>Arguments</h2>
<div class="variablelist"><dl>
<dt><span class="term"><code class="literal">HeapTuple <em class="parameter"><code>row</code></em></code></span></dt>
<dd><p>      row to be copied
     </p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id739173"></a><h2>Return Value</h2>
<p>   the copied row; <code class="symbol">NULL</code> only if
   <em class="parameter"><code>tuple</code></em> is <code class="symbol">NULL</code>
  </p>
</div>
</div></body>
</html>