begriffs open source - ai-pg/blob - full-docs/man3/SPI_freeplan.3

   1 '\" t
   2 .\"     Title: SPI_freeplan
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "SPI_FREEPLAN" "3" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 SPI_freeplan \- free a previously saved prepared statement
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 int SPI_freeplan(SPIPlanPtr \fIplan\fR)
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBSPI_freeplan\fR
  40 releases a prepared statement previously returned by
  41 \fBSPI_prepare\fR
  42 or saved by
  43 \fBSPI_keepplan\fR
  44 or
  45 \fBSPI_saveplan\fR\&.
  46 .SH "ARGUMENTS"
  47 .PP
  48 SPIPlanPtr \fIplan\fR
  49 .RS 4
  50 pointer to statement to free
  51 .RE
  52 .SH "RETURN VALUE"
  53 .PP
  54 0 on success;
  55 SPI_ERROR_ARGUMENT
  56 if
  57 \fIplan\fR
  58 is
  59 NULL
  60 or invalid