summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man3/SPI_palloc.3
blob: fdcf69eda7d6d17a0b4d8657b4d18d25405a6e1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
'\" t
.\"     Title: SPI_palloc
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2024
.\"    Manual: PostgreSQL 15.7 Documentation
.\"    Source: PostgreSQL 15.7
.\"  Language: English
.\"
.TH "SPI_PALLOC" "3" "2024" "PostgreSQL 15.7" "PostgreSQL 15.7 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
SPI_palloc \- allocate memory in the upper executor context
.SH "SYNOPSIS"
.sp
.nf
void * SPI_palloc(Size \fIsize\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_palloc\fR
allocates memory in the upper executor context\&.
.PP
This function can only be used while connected to SPI\&. Otherwise, it throws an error\&.
.SH "ARGUMENTS"
.PP
Size \fIsize\fR
.RS 4
size in bytes of storage to allocate
.RE
.SH "RETURN VALUE"
.PP
pointer to new storage space of the specified size