PostgreSQL 7.3.4 Documentation
Prev |  | Next

# SPI_getbinval

## Name

SPI_getbinval -- Returns the binary value of the specified attribute

## Synopsis

    SPI_getbinval(tuple, tupdesc, fnumber, isnull)

### Inputs

HeapTuple tuple

  Input tuple to be examined

TupleDesc tupdesc

  Input tuple description

int fnumber

  Attribute number

### Outputs

Datum

  Attribute binary value

bool * isnull

  flag for null value in attribute

SPI_result

  SPI_ERROR_NOATTRIBUTE

## Description

`SPI_getbinval` returns the specified attribute's value in internal form (as a Datum).

## Usage

Attribute numbers are 1 based.

## Algorithm

Does not allocate new space for the datum. In the case of a pass-by- reference data type, the Datum will be a pointer into the given tuple.

Prev | Home | Next
SPI_getvalue | Up | SPI_gettype