PostgreSQL: Documentation: 17: SPI

September 4, 2025: PostgreSQL 18 RC 1 Released!

Supported Versions: Current (17) / 16 / 15 / 14 / 13

Development Versions: 18 / devel

Unsupported versions: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0

SPI_getargcount
Prev	Up	45.1. Interface Functions	Home	Next

SPI_getargcount

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.

Prev	Up	Next
SPI_prepare_params	Home	SPI_getargtypeid

Submit correction

If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.