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

   1 '\" t
   2 .\"     Title: SPI_gettypeid
   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_GETTYPEID" "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_gettypeid \- return the data type OID of the specified column
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 Oid SPI_gettypeid(TupleDesc \fIrowdesc\fR, int \fIcolnumber\fR)
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBSPI_gettypeid\fR
  40 returns the
  41 OID
  42 of the data type of the specified column\&.
  43 .SH "ARGUMENTS"
  44 .PP
  45 TupleDesc \fIrowdesc\fR
  46 .RS 4
  47 input row description
  48 .RE
  49 .PP
  50 int \fIcolnumber\fR
  51 .RS 4
  52 column number (count starts at 1)
  53 .RE
  54 .SH "RETURN VALUE"
  55 .PP
  56 The
  57 OID
  58 of the data type of the specified column or
  59 InvalidOid
  60 on error\&. On error,
  61 \fISPI_result\fR
  62 is set to
  63 SPI_ERROR_NOATTRIBUTE\&.