]> begriffs open source - ai-pg/blob - full-docs/txt/spi-spi-cursor-move.txt
Convert HTML docs to more streamlined TXT
[ai-pg] / full-docs / txt / spi-spi-cursor-move.txt
1
2 SPI_cursor_move
3
4    SPI_cursor_move — move a cursor
5
6 Synopsis
7
8 void SPI_cursor_move(Portal portal, bool forward, long count)
9
10 Description
11
12    SPI_cursor_move skips over some number of rows in a cursor. This is
13    equivalent to a subset of the SQL command MOVE (see
14    SPI_scroll_cursor_move for more functionality).
15
16 Arguments
17
18    Portal portal
19           portal containing the cursor
20
21    bool forward
22           true for move forward, false for move backward
23
24    long count
25           maximum number of rows to move
26
27 Notes
28
29    Moving backward may fail if the cursor's plan was not created with the
30    CURSOR_OPT_SCROLL option.