begriffs open source - ai-pg/blob - full-docs/man3/SPI_getbinval.3

   1 '\" t
   2 .\"     Title: SPI_getbinval
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "SPI_GETBINVAL" "3" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 SPI_getbinval \- return the binary value of the specified column
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 Datum SPI_getbinval(HeapTuple \fIrow\fR, TupleDesc \fIrowdesc\fR, int \fIcolnumber\fR,
  36                     bool * \fIisnull\fR)
  37 .fi
  38 .SH "DESCRIPTION"
  39 .PP
  40 \fBSPI_getbinval\fR
  41 returns the value of the specified column in the internal form (as type
  42 Datum)\&.
  43 .PP
  44 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\&.
  45 .SH "ARGUMENTS"
  46 .PP
  47 HeapTuple \fIrow\fR
  48 .RS 4
  49 input row to be examined
  50 .RE
  51 .PP
  52 TupleDesc \fIrowdesc\fR
  53 .RS 4
  54 input row description
  55 .RE
  56 .PP
  57 int \fIcolnumber\fR
  58 .RS 4
  59 column number (count starts at 1)
  60 .RE
  61 .PP
  62 bool * \fIisnull\fR
  63 .RS 4
  64 flag for a null value in the column
  65 .RE
  66 .SH "RETURN VALUE"
  67 .PP
  68 The binary value of the column is returned\&. The variable pointed to by
  69 \fIisnull\fR
  70 is set to true if the column is null, else to false\&.
  71 .PP
  72 \fISPI_result\fR
  73 is set to
  74 SPI_ERROR_NOATTRIBUTE
  75 on error\&.