バージョンごとのドキュメント一覧

SPI_scroll_cursor_move

SPI_scroll_cursor_move <refpurpose>move a cursor</refpurpose> — カーソルを移動する

概要

void SPI_scroll_cursor_move(Portal portal, FetchDirection direction,
                            long count)

説明

<title>Description</title>

<function>SPI_scroll_cursor_move</function> skips over some number of rows in a cursor. This is equivalent to the SQL command <command>MOVE</command>. SPI_scroll_cursor_moveはカーソル内の行の一部をスキップします。 これはSQLコマンドMOVEと等価です。

引数

<title>Arguments</title>
Portal portal

portal containing the cursor カーソルを含むポータル

FetchDirection direction

one of <symbol>FETCH_FORWARD</symbol>, <symbol>FETCH_BACKWARD</symbol>, <symbol>FETCH_ABSOLUTE</symbol> or <symbol>FETCH_RELATIVE</symbol> FETCH_FORWARDFETCH_BACKWARDFETCH_ABSOLUTEFETCH_RELATIVEのいずれか

long count

number of rows to move for <symbol>FETCH_FORWARD</symbol> or <symbol>FETCH_BACKWARD</symbol>; absolute row number to move to for <symbol>FETCH_ABSOLUTE</symbol>; or relative row number to move to for <symbol>FETCH_RELATIVE</symbol> FETCH_FORWARDまたはFETCH_BACKWARDでは移動する行数。 FETCH_ABSOLUTEでは移動する行の絶対番号。 FETCH_RELATIVEでは移動する行の相対的番号。

戻り値

<title>Return Value</title>

<varname>SPI_processed</varname> is set as in <function>SPI_execute</function> if successful. <varname>SPI_tuptable</varname> is set to <symbol>NULL</symbol>, since no rows are returned by this function. 成功時、SPI_execute同様にSPI_processedが設定されます。 この関数は行を返しませんので、SPI_tuptableNULLに設定されます。

注釈

<title>Notes</title>

See the SQL <xref linkend="sql-fetch"/> command for details of the interpretation of the <parameter>direction</parameter> and <parameter>count</parameter> parameters. directionパラメータおよびcountパラメータの解釈の詳細についてはSQL FETCHコマンドを参照してください。

Direction values other than <symbol>FETCH_FORWARD</symbol> may fail if the cursor's plan was not created with the <symbol>CURSOR_OPT_SCROLL</symbol> option. カーソルの計画がCURSOR_OPT_SCROLLオプション付きで作成されていない場合、FETCH_FORWARD以外の方向値は失敗する可能性があります。