File: al_make_temp_file.3

package info (click to toggle)
allegro5 2%3A5.2.6.0-3%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 24,212 kB
  • sloc: ansic: 125,319; cpp: 15,781; objc: 4,579; python: 2,802; java: 2,254; javascript: 1,204; sh: 1,002; makefile: 51; perl: 37; xml: 25; pascal: 24
file content (31 lines) | stat: -rw-r--r-- 901 bytes parent folder | download
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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_make_temp_file" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_make_temp_file \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_FILE\ *al_make_temp_file(const\ char\ *template,\ ALLEGRO_PATH\ **ret_path)
\f[]
.fi
.SH DESCRIPTION
.PP
Make a temporary randomly named file given a filename
\[aq]template\[aq].
.PP
\[aq]template\[aq] is a string giving the format of the generated
filename and should include one or more capital Xs.
The Xs are replaced with random alphanumeric characters, produced using
a simple pseudo\-random number generator only.
There should be no path separators.
.PP
If \[aq]ret_path\[aq] is not NULL, the address it points to will be set
to point to a new path structure with the name of the temporary file.
.PP
Returns the opened ALLEGRO_FILE(3) on success, NULL on failure.