File: al_open_memfile.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (26 lines) | stat: -rw-r--r-- 740 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
.TH al_open_memfile 3 "" "Allegro reference manual"
.SH NAME
.PP
al_open_memfile \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro_memfile.h>

ALLEGRO_FILE\ *al_open_memfile(void\ *mem,\ int64_t\ size,\ const\ char\ *mode)
\f[]
.fi
.SH DESCRIPTION
.PP
Returns a file handle to the block of memory.
All read and write operations act upon the memory directly, so it must
not be freed while the file remains open.
.PP
The mode can be any combination of "r" (readable) and "w" (writable).
Regardless of the mode, the file always opens at position 0.
The file size is fixed and cannot be expanded.
.PP
It should be closed with al_fclose(3).
After the file is closed, you are responsible for freeing the memory (if
needed).