SPI_getargcount

Name

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

Synopsis

int SPI_getargcount(SPIPlanPtr plan)

Description

Note: At present, this section is just taken from PostgreSQL documentation and is subject to revision for Postgres-XC.

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

Arguments

Note: At present, this section is just taken from PostgreSQL documentation and is subject to revision for Postgres-XC.

SPIPlanPtr plan

prepared statement (returned by SPI_prepare)

Return Value

Note: At present, this section is just taken from PostgreSQL documentation and is subject to revision for Postgres-XC.

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.