<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_cursor_open_with_paramlist</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.3.9 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Interface Functions"
HREF="spi-interface.html"><LINK
REL="PREVIOUS"
TITLE="SPI_cursor_open_with_args"
HREF="spi-spi-cursor-open-with-args.html"><LINK
REL="NEXT"
TITLE="SPI_cursor_find"
HREF="spi-spi-cursor-find.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="2015-06-13T20:07:22"></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.3.9 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SPI_cursor_open_with_args"
HREF="spi-spi-cursor-open-with-args.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_find"
HREF="spi-spi-cursor-find.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-CURSOR-OPEN-WITH-PARAMLIST"
></A
>SPI_cursor_open_with_paramlist</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN62860"
></A
><H2
>Name</H2
>SPI_cursor_open_with_paramlist -- set up a cursor using parameters</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN62865"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>Portal SPI_cursor_open_with_paramlist(const char *<TT
CLASS="PARAMETER"
>name</TT
>,
SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
>,
ParamListInfo <TT
CLASS="PARAMETER"
>params</TT
>,
bool <TT
CLASS="PARAMETER"
>read_only</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN62871"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>SPI_cursor_open_with_paramlist</CODE
> sets up a cursor
(internally, a portal) that will execute a statement prepared by
<CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>.
This function is equivalent to <CODE
CLASS="FUNCTION"
>SPI_cursor_open</CODE
>
except that information about the parameter values to be passed to the
query is presented differently. The <TT
CLASS="LITERAL"
>ParamListInfo</TT
>
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 <TT
CLASS="LITERAL"
>ParamListInfo</TT
>.
</P
><P
> The passed-in parameter data will be copied into the cursor's portal, so it
can be freed while the cursor still exists.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN62880"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>const char * <TT
CLASS="PARAMETER"
>name</TT
></TT
></DT
><DD
><P
> name for portal, or <TT
CLASS="SYMBOL"
>NULL</TT
> to let the system
select a name
</P
></DD
><DT
><TT
CLASS="LITERAL"
>SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
></TT
></DT
><DD
><P
> prepared statement (returned by <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>)
</P
></DD
><DT
><TT
CLASS="LITERAL"
>ParamListInfo <TT
CLASS="PARAMETER"
>params</TT
></TT
></DT
><DD
><P
> data structure containing parameter types and values; NULL if none
</P
></DD
><DT
><TT
CLASS="LITERAL"
>bool <TT
CLASS="PARAMETER"
>read_only</TT
></TT
></DT
><DD
><P
><TT
CLASS="LITERAL"
>true</TT
> for read-only execution</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN62910"
></A
><H2
>Return Value</H2
><P
> Pointer to portal containing the cursor. Note there is no error
return convention; any error will be reported via <CODE
CLASS="FUNCTION"
>elog</CODE
>.
</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-cursor-open-with-args.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-find.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_cursor_open_with_args</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_find</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
