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
48
49
50
51
52
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>SPI_cursor_fetch</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.html#spi-interface" title="40.1.Interface Functions">
<link rel="prev" href="spi-spi-cursor-find.html" title="SPI_cursor_find">
<link rel="next" href="spi-spi-cursor-move.html" title="SPI_cursor_move">
<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-cursor-fetch"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>SPI_cursor_fetch — fetch some rows from a cursor</p>
</div>
<a name="id736962"></a><div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">void SPI_cursor_fetch(Portal <em class="parameter"><code>portal</code></em>, bool <em class="parameter"><code>forward</code></em>, long <em class="parameter"><code>count</code></em>)</pre>
</div>
<div class="refsect1" lang="en">
<a name="id736995"></a><h2>Description</h2>
<p> <code class="function">SPI_cursor_fetch</code> fetches some rows from a
cursor. This is equivalent to the SQL command <code class="command">FETCH</code>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id737016"></a><h2>Arguments</h2>
<div class="variablelist"><dl>
<dt><span class="term"><code class="literal">Portal <em class="parameter"><code>portal</code></em></code></span></dt>
<dd><p> portal containing the cursor
</p></dd>
<dt><span class="term"><code class="literal">bool <em class="parameter"><code>forward</code></em></code></span></dt>
<dd><p> true for fetch forward, false for fetch backward
</p></dd>
<dt><span class="term"><code class="literal">long <em class="parameter"><code>count</code></em></code></span></dt>
<dd><p> maximum number of rows to fetch
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id737073"></a><h2>Return Value</h2>
<p> <code class="varname">SPI_processed</code> and
<code class="varname">SPI_tuptable</code> are set as in
<code class="function">SPI_execute</code> if successful.
</p>
</div>
</div></body>
</html>
|
