select open change scope Open full search

PG.CENTER connects PostgreSQL documentation, reference, and ecosystem knowledge. Maintained by Pigsty.

Supported versions: Current (18) / 17 / 16 / 15 / 14
Development versions: 19 / devel
Unsupported versions: 13 / 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
Historical version. PostgreSQL 9.1 reached end of support in October 2016. See the current version for supported releases.

SPI_getargtypeid

Name

SPI_getargtypeid -- return the data type OID for an argument of a plan prepared by SPI_prepare

Synopsis

Oid SPI_getargtypeid(SPIPlanPtr plan, int argIndex)

Description

SPI_getargtypeid returns the OID representing the type for the argIndex'th argument of a plan prepared by SPI_prepare. First argument is at index zero.

Arguments

SPIPlanPtr plan

execution plan (returned by SPI_prepare)

int argIndex

zero based index of the argument

Return Value

The type OID of the argument at the given index. If the plan is NULL or invalid, or argIndex is less than 0 or not less than the number of arguments declared for the plan, SPI_result is set to SPI_ERROR_ARGUMENT and InvalidOid is returned.

Report a documentation issue

Read the upstream documentation. For corrections, first check the current version.