SPI_scroll_cursor_move
SPI_scroll_cursor_move — move a cursor
Synopsis
void SPI_scroll_cursor_move(Portalportal
, FetchDirectiondirection
, longcount
)
Description
SPI_scroll_cursor_move
skips over some number of rows in a cursor. This is equivalent to the SQL command MOVE
.
Arguments
Portal
portal
portal containing the cursor
FetchDirection
direction
one of
FETCH_FORWARD
,FETCH_BACKWARD
,FETCH_ABSOLUTE
orFETCH_RELATIVE
long
count
number of rows to move for
FETCH_FORWARD
orFETCH_BACKWARD
; absolute row number to move to forFETCH_ABSOLUTE
; or relative row number to move to forFETCH_RELATIVE
Return Value
SPI_processed
is set as in SPI_execute
if successful. SPI_tuptable
is set to NULL
, since no rows are returned by this function.
Notes
See the SQL FETCH command for details of the interpretation of the direction
and count
parameters.
Direction values other than FETCH_FORWARD
may fail if the cursor's plan was not created with the CURSOR_OPT_SCROLL
option.