---
name: "SPI_getbinval"
section: "3"
platform: "linux"
package: "postgresql"
version: "18.6-4"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/SPI_getbinval"
---

# SPI\_getbinval(3)

return the binary value of the specified column

## NAME

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.
