SPI_returntuple (3) - Linux Manuals

SPI_returntuple: prepare to return a tuple as a Datum

Command to display SPI_returntuple manual in Linux: $ man 3 SPI_returntuple

NAME

SPI_returntuple - prepare to return a tuple as a Datum

SYNOPSIS

HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc)

DESCRIPTION

SPI_returntuple makes a copy of a row in the upper executor context, returning it in the form of a row type Datum. The returned pointer need only be converted to Datum via PointerGetDatum before returning.

Note that this should be used for functions that are declared to return composite types. It is not used for triggers; use SPI_copytuple for returning a modified row in a trigger.

ARGUMENTS

HeapTuple row

: row to be copied

TupleDesc rowdesc

: descriptor for row (pass the same descriptor each time for most effective caching)

RETURN VALUE

HeapTupleHeader pointing to copied row; NULL only if row or rowdesc is NULL