PostgreSQL 8.4.17 Documentation
Prev | Fast Backward |  | Fast Forward | Next

# SPI_getargcount

## Name

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

## Synopsis

    int SPI_getargcount(SPIPlanPtr plan)

## Description

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

## Arguments

`SPIPlanPtr `plan``

  execution plan (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 | Home | Next
SPI_prepare_cursor | Up | SPI_getargtypeid