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

   1 '\" t
   2 .\"     Title: SPI_cursor_find
   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_CURSOR_FIND" "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_cursor_find \- find an existing cursor by name
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 Portal SPI_cursor_find(const char * \fIname\fR)
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBSPI_cursor_find\fR
  40 finds an existing portal by name\&. This is primarily useful to resolve a cursor name returned as text by some other function\&.
  41 .SH "ARGUMENTS"
  42 .PP
  43 const char * \fIname\fR
  44 .RS 4
  45 name of the portal
  46 .RE
  47 .SH "RETURN VALUE"
  48 .PP
  49 pointer to the portal with the specified name, or
  50 NULL
  51 if none was found
  52 .SH "NOTES"
  53 .PP
  54 Beware that this function can return a
  55 Portal
  56 object that does not have cursor\-like properties; for example it might not return tuples\&. If you simply pass the
  57 Portal
  58 pointer to other SPI functions, they can defend themselves against such cases, but caution is appropriate when directly inspecting the
  59 Portal\&.