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

   1 '\" t
   2 .\"     Title: SPI_getargcount
   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_GETARGCOUNT" "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_getargcount \- return the number of arguments needed by a statement prepared by \fBSPI_prepare\fR
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 int SPI_getargcount(SPIPlanPtr \fIplan\fR)
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBSPI_getargcount\fR
  40 returns the number of arguments needed to execute a statement prepared by
  41 \fBSPI_prepare\fR\&.
  42 .SH "ARGUMENTS"
  43 .PP
  44 SPIPlanPtr \fIplan\fR
  45 .RS 4
  46 prepared statement (returned by
  47 \fBSPI_prepare\fR)
  48 .RE
  49 .SH "RETURN VALUE"
  50 .PP
  51 The count of expected arguments for the
  52 \fIplan\fR\&. If the
  53 \fIplan\fR
  54 is
  55 NULL
  56 or invalid,
  57 \fISPI_result\fR
  58 is set to
  59 SPI_ERROR_ARGUMENT
  60 and \-1 is returned\&.