'\" t
.\"     Title: SPI_scroll_cursor_move
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2024
.\"    Manual: PostgreSQL 16.2 Documentation
.\"    Source: PostgreSQL 16.2
.\"  Language: English
.\"
.TH "SPI_SCROLL_CURSOR_MOVE" "3" "2024" "PostgreSQL 16.2" "PostgreSQL 16.2 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
SPI_scroll_cursor_move \- move a cursor
.SH "SYNOPSIS"
.sp
.nf
void SPI_scroll_cursor_move(Portal \fIportal\fR, FetchDirection \fIdirection\fR,
                            long \fIcount\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_scroll_cursor_move\fR
skips over some number of rows in a cursor\&. This is equivalent to the SQL command
\fBMOVE\fR\&.
.SH "ARGUMENTS"
.PP
Portal \fIportal\fR
.RS 4
portal containing the cursor
.RE
.PP
FetchDirection \fIdirection\fR
.RS 4
one of
FETCH_FORWARD,
FETCH_BACKWARD,
FETCH_ABSOLUTE
or
FETCH_RELATIVE
.RE
.PP
long \fIcount\fR
.RS 4
number of rows to move for
FETCH_FORWARD
or
FETCH_BACKWARD; absolute row number to move to for
FETCH_ABSOLUTE; or relative row number to move to for
FETCH_RELATIVE
.RE
.SH "RETURN VALUE"
.PP
\fISPI_processed\fR
is set as in
\fBSPI_execute\fR
if successful\&.
\fISPI_tuptable\fR
is set to
NULL, since no rows are returned by this function\&.
.SH "NOTES"
.PP
See the SQL
\fBFETCH\fR(7)
command for details of the interpretation of the
\fIdirection\fR
and
\fIcount\fR
parameters\&.
.PP
Direction values other than
FETCH_FORWARD
may fail if the cursor\*(Aqs plan was not created with the
CURSOR_OPT_SCROLL
option\&.