SPI_getargtypeid (3)

Leading comments

    Title: SPI_getargtypeid
   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_getargtypeid.3".)

NAME

SPI_getargtypeid - return the data type OID for an argument of a statement 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 statement prepared by SPI_prepare. First argument is at index zero.

ARGUMENTS

SPIPlanPtr plan

prepared statement (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.