1. Manuals
  2. Tumbleweed
  3. postgresql16-docs
  4. SPI_getvalue(3pg16)

Scroll to navigation

SPI_GETVALUE(3) PostgreSQL 16.6 Documentation SPI_GETVALUE(3)

NAME

SPI_getvalue - return the string value of the specified column

SYNOPSIS

char * SPI_getvalue(HeapTuple row, TupleDesc rowdesc, int colnumber)

DESCRIPTION

SPI_getvalue returns the string representation of the value of the specified column.

The result is returned in memory allocated using palloc. (You can use pfree to release the memory when you don't need it anymore.)

ARGUMENTS

HeapTuple row

input row to be examined

TupleDesc rowdesc

input row description

int colnumber

column number (count starts at 1)

RETURN VALUE

Column value, or NULL if the column is null, colnumber is out of range (SPI_result is set to SPI_ERROR_NOATTRIBUTE), or no output function is available (SPI_result is set to SPI_ERROR_NOOUTFUNC).

2024 PostgreSQL 16.6