SPI\_cursor\_open\_with\_paramlist

|    SPI\_cursor\_open\_with\_paramlist    |                        |                         |                  |                                       |
|:----------------------------------------:|------------------------|-------------------------|------------------|---------------------------------------|
|[Prev](spi-spi-cursor-open-with-args.html)|[Up](spi-interface.html)|47.1. Interface Functions|[Home](index.html)| [Next](spi-spi-cursor-parse-open.html)|

---

[]()

## SPI\_cursor\_open\_with\_paramlist

SPI\_cursor\_open\_with\_paramlist — set up a cursor using parameters

## Synopsis

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

```

## Description

`SPI_cursor_open_with_paramlist` sets up a cursor (internally, a portal) that will execute a statement prepared by `SPI_prepare`. This function is equivalent to `SPI_cursor_open` except that information about the parameter values to be passed to the query is presented differently. The `ParamListInfo` representation can be convenient for passing down values that are already available in that format. It also supports use of dynamic parameter sets via hook functions specified in `ParamListInfo`.

 The passed-in parameter data will be copied into the cursor's portal, so it can be freed while the cursor still exists.

## Arguments

`const char * *`name`*`

 name for portal, or `NULL` to let the system select a name

`SPIPlanPtr *`plan`*`

 prepared statement (returned by `SPI_prepare`)

`ParamListInfo *`params`*`

 data structure containing parameter types and values; NULL if none

`bool *`read_only`*`

`true` for read-only execution

## Return Value

 Pointer to portal containing the cursor. Note there is no error return convention; any error will be reported via `elog`.

---

|[Prev](spi-spi-cursor-open-with-args.html)|[Up](spi-interface.html)| [Next](spi-spi-cursor-parse-open.html)|
|:-----------------------------------------|:----------------------:|--------------------------------------:|
|      SPI\_cursor\_open\_with\_args       |   [Home](index.html)   |        SPI\_cursor\_parse\_open       |

 // \<![CDATA[ \<-- For SVG support if ('WebSocket' in window) { (function() { function refreshCSS() { var sheets = [].slice.call(document.getElementsByTagName("link")); var head = document.getElementsByTagName("head")[0]; for (var i = 0; i \< sheets.length; ++i) { var elem = sheets[i]; head.removeChild(elem); var rel = elem.rel; if (elem.href && typeof rel != "string" || rel.length == 0 || rel.toLowerCase() == "stylesheet") { var url = elem.href.replace(/(&|\\?)\_cacheOverride=\\d+/, ''); elem.href = url + (url.indexOf('?') \>= 0 ? '&' : '?') + '\_cacheOverride=' + (new Date().valueOf()); } head.appendChild(elem); } } var protocol = window.location.protocol === 'http:' ? 'ws://' : 'wss://'; var address = protocol + window.location.host + window.location.pathname + '/ws'; var socket = new WebSocket(address); socket.onmessage = function(msg) { if (msg.data == 'reload') window.location.reload(); else if (msg.data == 'refreshcss') refreshCSS(); }; console.log('Live reload enabled.'); })(); } // ]]\>