~ubuntu-branches/ubuntu/utopic/pgadmin3/utopic-proposed

« back to all changes in this revision

Viewing changes to docs/en_US/pg/spi-spi-copytuple.html

  • Committer: Bazaar Package Importer
  • Author(s): Raphael Enrici
  • Date: 2004-12-14 23:46:39 UTC
  • Revision ID: james.westby@ubuntu.com-20041214234639-tve0i5l49fq13jli
Tags: upstream-1.2.0
Import upstream version 1.2.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 
4
<title>SPI_copytuple</title>
 
5
<link rel="stylesheet" href="stylesheet.css" type="text/css">
 
6
<link rev="made" href="pgsql-docs@postgresql.org">
 
7
<meta name="generator" content="DocBook XSL Stylesheets V1.64.1">
 
8
<link rel="home" href="index.html" title="PostgreSQL 8.0.0beta5 Documentation">
 
9
<link rel="up" href="spi-memory.html" title="39.3.�Memory Management">
 
10
<link rel="previous" href="spi-spi-pfree.html" title="SPI_pfree">
 
11
<link rel="next" href="spi-spi-returntuple.html" title="SPI_returntuple">
 
12
</head>
 
13
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
 
14
<a name="spi-spi-copytuple"></a><div class="titlepage">
 
15
<div></div>
 
16
<div></div>
 
17
</div>
 
18
<div class="refnamediv">
 
19
<h2>Name</h2>
 
20
<p>SPI_copytuple &#8212; make a copy of a row in the upper executor context</p>
 
21
</div>
 
22
<a name="id2659221"></a><div class="refsynopsisdiv">
 
23
<h2>Synopsis</h2>
 
24
<pre class="synopsis">HeapTuple SPI_copytuple(HeapTuple <i class="parameter"><tt>row</tt></i>)</pre>
 
25
</div>
 
26
<div class="refsect1" lang="en">
 
27
<a name="id2659239"></a><h2>Description</h2>
 
28
<p>   <tt class="function">SPI_copytuple</tt> makes a copy of a row in the
 
29
   upper executor context.  This is normally used to return a modified
 
30
   row from a trigger.  In a function declared to return a composite
 
31
   type, use <tt class="function">SPI_returntuple</tt> instead.
 
32
  </p>
 
33
</div>
 
34
<div class="refsect1" lang="en">
 
35
<a name="id2659260"></a><h2>Arguments</h2>
 
36
<div class="variablelist"><dl>
 
37
<dt><span class="term"><tt class="literal">HeapTuple <i class="parameter"><tt>row</tt></i></tt></span></dt>
 
38
<dd><p>      row to be copied
 
39
     </p></dd>
 
40
</dl></div>
 
41
</div>
 
42
<div class="refsect1" lang="en">
 
43
<a name="id2659279"></a><h2>Return Value</h2>
 
44
<p>   the copied row; <tt class="symbol">NULL</tt> only if
 
45
   <i class="parameter"><tt>tuple</tt></i> is <tt class="symbol">NULL</tt>
 
46
  </p>
 
47
</div>
 
48
</div></body>
 
49
</html>