|
1
by Martin Pitt
Import upstream version 9.1~beta1 |
1 |
'\" t
|
2 |
.\" Title: SPI_scroll_cursor_move |
|
3 |
.\" Author: The PostgreSQL Global Development Group |
|
|
1.1.6
by Martin Pitt
Import upstream version 9.1.2 |
4 |
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> |
|
1.1.11
by Martin Pitt
Import upstream version 9.1.9 |
5 |
.\" Date: 2013-04-01 |
6 |
.\" Manual: PostgreSQL 9.1.9 Documentation |
|
7 |
.\" Source: PostgreSQL 9.1.9 |
|
|
1
by Martin Pitt
Import upstream version 9.1~beta1 |
8 |
.\" Language: English |
9 |
.\" |
|
|
1.1.11
by Martin Pitt
Import upstream version 9.1.9 |
10 |
.TH "SPI_SCROLL_CURSOR_MOVE" "3" "2013-04-01" "PostgreSQL 9.1.9" "PostgreSQL 9.1.9 Documentation" |
|
1.1.6
by Martin Pitt
Import upstream version 9.1.2 |
11 |
.\" ----------------------------------------------------------------- |
12 |
.\" * Define some portability stuff |
|
13 |
.\" ----------------------------------------------------------------- |
|
14 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
15 |
.\" http://bugs.debian.org/507673 |
|
16 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
|
17 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
18 |
.ie \n(.g .ds Aq \(aq |
|
19 |
.el .ds Aq ' |
|
|
1
by Martin Pitt
Import upstream version 9.1~beta1 |
20 |
.\" ----------------------------------------------------------------- |
21 |
.\" * set default formatting |
|
22 |
.\" ----------------------------------------------------------------- |
|
23 |
.\" disable hyphenation |
|
24 |
.nh
|
|
25 |
.\" disable justification (adjust text to left margin only) |
|
26 |
.ad l |
|
27 |
.\" ----------------------------------------------------------------- |
|
28 |
.\" * MAIN CONTENT STARTS HERE * |
|
29 |
.\" ----------------------------------------------------------------- |
|
30 |
.SH "NAME" |
|
31 |
SPI_scroll_cursor_move \- move a cursor
|
|
32 |
.\" SPI_scroll_cursor_move |
|
33 |
.SH "SYNOPSIS" |
|
34 |
.sp
|
|
35 |
.nf
|
|
36 |
void SPI_scroll_cursor_move(Portal \fIportal\fR, FetchDirection \fIdirection\fR, |
|
37 |
long \fIcount\fR) |
|
38 |
.fi
|
|
39 |
.SH "DESCRIPTION" |
|
40 |
.PP
|
|
|
1.1.3
by Martin Pitt
Import upstream version 9.1~rc1 |
41 |
|
|
1
by Martin Pitt
Import upstream version 9.1~beta1 |
42 |
\fBSPI_scroll_cursor_move\fR |
43 |
skips over some number of rows in a cursor\&. This is equivalent to the SQL command
|
|
44 |
MOVE\&.
|
|
45 |
.SH "ARGUMENTS" |
|
46 |
.PP
|
|
47 |
Portal \fIportal\fR |
|
48 |
.RS 4 |
|
49 |
portal containing the cursor |
|
50 |
.RE
|
|
51 |
.PP
|
|
52 |
FetchDirection \fIdirection\fR |
|
53 |
.RS 4 |
|
54 |
one of |
|
55 |
FETCH_FORWARD, |
|
56 |
FETCH_BACKWARD, |
|
57 |
FETCH_ABSOLUTE |
|
58 |
or |
|
59 |
FETCH_RELATIVE |
|
60 |
.RE
|
|
61 |
.PP
|
|
62 |
long \fIcount\fR |
|
63 |
.RS 4 |
|
64 |
number of rows to move for |
|
65 |
FETCH_FORWARD |
|
66 |
or |
|
67 |
FETCH_BACKWARD; absolute row number to move to for |
|
68 |
FETCH_ABSOLUTE; or relative row number to move to for |
|
69 |
FETCH_RELATIVE |
|
70 |
.RE
|
|
71 |
.SH "RETURN VALUE" |
|
72 |
.PP
|
|
|
1.1.3
by Martin Pitt
Import upstream version 9.1~rc1 |
73 |
|
|
1
by Martin Pitt
Import upstream version 9.1~beta1 |
74 |
\fISPI_processed\fR |
75 |
is set as in |
|
76 |
\fBSPI_execute\fR |
|
77 |
if successful\&.
|
|
78 |
\fISPI_tuptable\fR |
|
79 |
is set to |
|
80 |
NULL, since no rows are returned by this function\&.
|
|
81 |
.SH "NOTES" |
|
82 |
.PP
|
|
83 |
See the SQL |
|
84 |
\fBFETCH\fR(7) |
|
85 |
command for details of the interpretation of the |
|
86 |
\fIdirection\fR |
|
87 |
and |
|
88 |
\fIcount\fR |
|
89 |
parameters\&.
|
|
90 |
.PP
|
|
91 |
Direction values other than |
|
92 |
FETCH_FORWARD |
|
|
1.1.6
by Martin Pitt
Import upstream version 9.1.2 |
93 |
may fail if the cursor\*(Aqs plan was not created with the
|
|
1
by Martin Pitt
Import upstream version 9.1~beta1 |
94 |
CURSOR_OPT_SCROLL |
95 |
option\&.
|