PostgreSQL 9.1.1文書
前のページ | 巻戻し |  | 早送り | 次のページ

# SPI_cursor_open_with_paramlist

## 名前

SPI_cursor_open_with_paramlist -- パラメータを使ってカーソルを設定する

## 概要

    Portal SPI_cursor_open_with_paramlist(const char *name,
                                          SPIPlanPtr plan,
                                          ParamListInfo params,
                                          bool read_only)

## 説明

`SPI_cursor_open_with_paramlist`は`SPI_prepare`で準備された計画を実行するカーソル(内部的にはポータル)を設定します。 この関数は`SPI_cursor_open`と同じですが、問い合わせに渡されるパラメータ値に関する情報が別途存在することが異なります。 `ParamListInfo`表現は、すでに利用可能な形式で値を渡すために便利です。 また`ParamListInfo`で指定されたフック関数経由での動的なパラメータ群の使用をサポートします。

渡されるパラメータデータはカーソルのポータルにコピーされます。 そのため、カーソルが存在している間にそのデータを解放することができます。

## 引数

`const char * `name``

  ポータルの名前、あるいはシステムに名前を決定させる場合は`NULL`

`SPIPlanPtr `plan``

  （`SPI_prepare`で返される）実行計画

`ParamListInfo `params``

  パラメータの型と値からなるデータ構造。 なければヌル。

`bool `read_only``

  読み取りのみの実行の場合`true`

## 戻り値

カーソルを含むポータルへのポインタ。 戻り値の規約にはエラーを表すものがないことに注意してください。 エラーはすべて`elog`経由で報告されます。

前のページ | ホーム | 次のページ
SPI_cursor_open_with_args | 上に戻る | SPI_cursor_find