1#@!#!123s

: / opt / alt / postgresql11 / usr / share / doc / alt-postgresql11-9.2.24 / html /
Filename : spi-spi-prepare-params.html
back
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_prepare_params</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_prepare_cursor"
HREF="spi-spi-prepare-cursor.html"><LINK
REL="NEXT"
TITLE="SPI_getargcount"
HREF="spi-spi-getargcount.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_prepare_cursor"
HREF="spi-spi-prepare-cursor.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_getargcount"
HREF="spi-spi-getargcount.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-PREPARE-PARAMS"
></A
>SPI_prepare_params</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN60609"
></A
><H2
>Name</H2
>SPI_prepare_params&nbsp;--&nbsp;prepare a statement, without executing it yet</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN60614"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>SPIPlanPtr SPI_prepare_params(const char * <TT
CLASS="PARAMETER"
>command</TT
>,
                              ParserSetupHook <TT
CLASS="PARAMETER"
>parserSetup</TT
>,
                              void * <TT
CLASS="PARAMETER"
>parserSetupArg</TT
>,
                              int <TT
CLASS="PARAMETER"
>cursorOptions</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60620"
></A
><H2
>Description</H2
><P
>   <CODE
CLASS="FUNCTION"
>SPI_prepare_params</CODE
> creates and returns a prepared
   statement for the specified command, but doesn't execute the command.
   This function is equivalent to <CODE
CLASS="FUNCTION"
>SPI_prepare_cursor</CODE
>,
   with the addition that the caller can specify parser hook functions
   to control the parsing of external parameter references.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60625"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>const char * <TT
CLASS="PARAMETER"
>command</TT
></TT
></DT
><DD
><P
>      command string
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>ParserSetupHook <TT
CLASS="PARAMETER"
>parserSetup</TT
></TT
></DT
><DD
><P
>      Parser hook setup function
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>void * <TT
CLASS="PARAMETER"
>parserSetupArg</TT
></TT
></DT
><DD
><P
>      passthrough argument for <TT
CLASS="PARAMETER"
>parserSetup</TT
>
     </P
></DD
><DT
><TT
CLASS="LITERAL"
>int <TT
CLASS="PARAMETER"
>cursorOptions</TT
></TT
></DT
><DD
><P
>      integer bit mask of cursor options; zero produces default behavior
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN60653"
></A
><H2
>Return Value</H2
><P
>   <CODE
CLASS="FUNCTION"
>SPI_prepare_params</CODE
> has the same return conventions as
   <CODE
CLASS="FUNCTION"
>SPI_prepare</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-prepare-cursor.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-getargcount.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_prepare_cursor</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_getargcount</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>