MAINHACK

Viewing / Editing File: spi-spi-scroll-cursor-move.html

File is not writable. Editing disabled.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_scroll_cursor_move</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.2.24 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Interface Functions"
HREF="spi-interface.html"><LINK
REL="PREVIOUS"
TITLE="SPI_scroll_cursor_fetch"
HREF="spi-spi-scroll-cursor-fetch.html"><LINK
REL="NEXT"
TITLE="SPI_cursor_close"
HREF="spi-spi-cursor-close.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2017-11-06T22:43:11"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.2.24 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SPI_scroll_cursor_fetch"
HREF="spi-spi-scroll-cursor-fetch.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="SPI_cursor_close"
HREF="spi-spi-cursor-close.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-SCROLL-CURSOR-MOVE"
></A
>SPI_scroll_cursor_move</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN61425"
></A
><H2
>Name</H2
>SPI_scroll_cursor_move&nbsp;--&nbsp;move a cursor</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN61430"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>void SPI_scroll_cursor_move(Portal <TT
CLASS="PARAMETER"
>portal</TT
>, FetchDirection <TT
CLASS="PARAMETER"
>direction</TT
>,
                            long <TT
CLASS="PARAMETER"
>count</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61435"
></A
><H2
>Description</H2
><P
>   <CODE
CLASS="FUNCTION"
>SPI_scroll_cursor_move</CODE
> skips over some number of rows
   in a cursor.  This is equivalent to the SQL command
   <TT
CLASS="COMMAND"
>MOVE</TT
>.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61440"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>Portal <TT
CLASS="PARAMETER"
>portal</TT
></TT
></DT
><DD
><P
>      portal containing the cursor
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>FetchDirection <TT
CLASS="PARAMETER"
>direction</TT
></TT
></DT
><DD
><P
>      one of <TT
CLASS="SYMBOL"
>FETCH_FORWARD</TT
>,
      <TT
CLASS="SYMBOL"
>FETCH_BACKWARD</TT
>,
      <TT
CLASS="SYMBOL"
>FETCH_ABSOLUTE</TT
> or
      <TT
CLASS="SYMBOL"
>FETCH_RELATIVE</TT
>
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>long <TT
CLASS="PARAMETER"
>count</TT
></TT
></DT
><DD
><P
>      number of rows to move for
      <TT
CLASS="SYMBOL"
>FETCH_FORWARD</TT
> or
      <TT
CLASS="SYMBOL"
>FETCH_BACKWARD</TT
>; absolute row number to move to for
      <TT
CLASS="SYMBOL"
>FETCH_ABSOLUTE</TT
>; or relative row number to move to for
      <TT
CLASS="SYMBOL"
>FETCH_RELATIVE</TT
>
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61469"
></A
><H2
>Return Value</H2
><P
>   <TT
CLASS="VARNAME"
>SPI_processed</TT
> is set as in
   <CODE
CLASS="FUNCTION"
>SPI_execute</CODE
> if successful.
   <TT
CLASS="VARNAME"
>SPI_tuptable</TT
> is set to <TT
CLASS="SYMBOL"
>NULL</TT
>, since
   no rows are returned by this function.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN61476"
></A
><H2
>Notes</H2
><P
>   See the SQL <A
HREF="sql-fetch.html"
>FETCH</A
> command
   for details of the interpretation of the
   <TT
CLASS="PARAMETER"
>direction</TT
> and
   <TT
CLASS="PARAMETER"
>count</TT
> parameters.
  </P
><P
>   Direction values other than <TT
CLASS="SYMBOL"
>FETCH_FORWARD</TT
>
   may fail if the cursor's plan was not created
   with the <TT
CLASS="SYMBOL"
>CURSOR_OPT_SCROLL</TT
> option.
  </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-spi-scroll-cursor-fetch.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="spi-spi-cursor-close.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_scroll_cursor_fetch</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SPI_cursor_close</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Cancel / Back
[ MAINHACK ]

Viewing / Editing File: spi-spi-scroll-cursor-move.html

Server Info

System Features

User Info
