SPI_getargcount (3)

Leading comments

    Title: SPI_getargcount
   Author: The PostgreSQL Global Development Group
Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
     Date: 2017
   Manual: PostgreSQL 9.6.5 Documentation
   Source: PostgreSQL 9.6.5
 Language: English

(The comments found at the beginning of the groff file "man3/SPI_getargcount.3".)

NAME

SPI_getargcount - return the number of arguments needed by a statement prepared by SPI_prepare

SYNOPSIS

int SPI_getargcount(SPIPlanPtr plan)

DESCRIPTION

SPI_getargcount returns the number of arguments needed to execute a statement prepared by SPI_prepare.

ARGUMENTS

SPIPlanPtr plan

prepared statement (returned by SPI_prepare)

RETURN VALUE

The count of expected arguments for the plan. If the plan is NULL or invalid, SPI_result is set to SPI_ERROR_ARGUMENT and -1 is returned.