begriffs open source - ai-pg/blob - full-docs/txt/spi-spi-getvalue.txt

   1
   2 SPI_getvalue
   3
   4    SPI_getvalue — return the string value of the specified column
   5
   6 Synopsis
   7
   8 char * SPI_getvalue(HeapTuple row, TupleDesc rowdesc, int colnumber)
   9
  10 Description
  11
  12    SPI_getvalue returns the string representation of the value of the
  13    specified column.
  14
  15    The result is returned in memory allocated using palloc. (You can use
  16    pfree to release the memory when you don't need it anymore.)
  17
  18 Arguments
  19
  20    HeapTuple row
  21           input row to be examined
  22
  23    TupleDesc rowdesc
  24           input row description
  25
  26    int colnumber
  27           column number (count starts at 1)
  28
  29 Return Value
  30
  31    Column value, or NULL if the column is null, colnumber is out of range
  32    (SPI_result is set to SPI_ERROR_NOATTRIBUTE), or no output function is
  33    available (SPI_result is set to SPI_ERROR_NOOUTFUNC).