PostgreSQL

PostgreSQL Elephant Logo

SPI_getbinval

SPI_getbinval — return the binary value of the specified column

Synopsis

Datum SPI_getbinval(HeapTuple row, TupleDesc rowdesc, int colnumber,
                    bool * isnull)

Description

SPI_getbinval returns the value of the specified column in the internal form (as type Datum).

This function does not allocate new space for the datum. In the case of a pass-by-reference data type, the return value will be a pointer into the passed row.

Arguments

`HeapTuple +`_`+row`_

input row to be examined

`TupleDesc +`_`+rowdesc`_

input row description

`int +`_`+colnumber`_

column number (count starts at 1)

`bool * +`_`+isnull`_

flag for a null value in the column

Return Value

The binary value of the column is returned. The variable pointed to by `isnull` is set to true if the column is null, else to false.

SPI_result is set to SPI_ERROR_NOATTRIBUTE on error.


Prev Up Next

SPI_getvalue

Home

SPI_gettype

Copyright © 1996-2023 The PostgreSQL Global Development Group