<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SPI_is_cursor_plan</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="spi-spi-getargtypeid.html" title="SPI_getargtypeid" /><link rel="next" href="spi-spi-execute-plan.html" title="SPI_execute_plan" /></head><body><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">SPI_is_cursor_plan</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="spi-spi-getargtypeid.html" title="SPI_getargtypeid">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="spi-interface.html" title="47.1. Interface Functions">Up</a></td><th width="60%" align="center">47.1. Interface Functions</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 11.5 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="spi-spi-execute-plan.html" title="SPI_execute_plan">Next</a></td></tr></table><hr></hr></div><div class="refentry" id="SPI-SPI-IS-CURSOR-PLAN"><div class="titlepage"></div><a id="id-1.8.12.8.12.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">SPI_is_cursor_plan</span></h2><p>SPI_is_cursor_plan — return <code class="symbol">true</code> if a statement
prepared by <code class="function">SPI_prepare</code> can be used with
<code class="function">SPI_cursor_open</code></p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
bool SPI_is_cursor_plan(SPIPlanPtr <em class="parameter"><code>plan</code></em>)
</pre></div><div class="refsect1" id="id-1.8.12.8.12.5"><h2>Description</h2><p>
<code class="function">SPI_is_cursor_plan</code> returns <code class="symbol">true</code>
if a statement prepared by <code class="function">SPI_prepare</code> can be passed
as an argument to <code class="function">SPI_cursor_open</code>, or
<code class="symbol">false</code> if that is not the case. The criteria are that the
<em class="parameter"><code>plan</code></em> represents one single command and that this
command returns tuples to the caller; for example, <code class="command">SELECT</code>
is allowed unless it contains an <code class="literal">INTO</code> clause, and
<code class="command">UPDATE</code> is allowed only if it contains a <code class="literal">RETURNING</code>
clause.
</p></div><div class="refsect1" id="id-1.8.12.8.12.6"><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">SPIPlanPtr <em class="parameter"><code>plan</code></em></code></span></dt><dd><p>
prepared statement (returned by <code class="function">SPI_prepare</code>)
</p></dd></dl></div></div><div class="refsect1" id="id-1.8.12.8.12.7"><h2>Return Value</h2><p>
<code class="symbol">true</code> or <code class="symbol">false</code> to indicate if the
<em class="parameter"><code>plan</code></em> can produce a cursor or not, with
<code class="varname">SPI_result</code> set to zero.
If it is not possible to determine the answer (for example,
if the <em class="parameter"><code>plan</code></em> is <code class="symbol">NULL</code> or invalid,
or if called when not connected to SPI), then
<code class="varname">SPI_result</code> is set to a suitable error code
and <code class="symbol">false</code> is returned.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="spi-spi-getargtypeid.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="spi-interface.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="spi-spi-execute-plan.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SPI_getargtypeid </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SPI_execute_plan</td></tr></table></div></body></html>
