SPI_scroll_cursor_fetch
SPI_scroll_cursor_fetch
SPI_scroll_cursor_fetch - fetch some rows from a cursor
Synopsis
void SPI_scroll_cursor_fetch(Portalportal, FetchDirectiondirection, longcount)
Description
SPI_scroll_cursor_fetch
fetches some rows from a
cursor. This is equivalent to the SQL command
FETCH
.
Arguments
-
Portalportal -
portal containing the cursor
-
FetchDirectiondirection -
one of
FETCH_FORWARD,FETCH_BACKWARD,FETCH_ABSOLUTEorFETCH_RELATIVE -
longcount -
number of rows to fetch for
FETCH_FORWARDorFETCH_BACKWARD; absolute row number to fetch forFETCH_ABSOLUTE; or relative row number to fetch forFETCH_RELATIVE
Return Value
SPI_processed
and
SPI_tuptable
are set as in
SPI_execute
if successful.
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.