File: al_fseek.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (37 lines) | stat: -rw-r--r-- 916 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
32
33
34
35
36
37
.TH "al_fseek" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_fseek \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_fseek(ALLEGRO_FILE\ *f,\ int64_t\ offset,\ int\ whence)
\f[]
.fi
.SH DESCRIPTION
.PP
Set the current position of the given file to a position relative to
that specified by \[aq]whence\[aq], plus \[aq]offset\[aq] number of
bytes.
.PP
\[aq]whence\[aq] can be:
.IP \[bu] 2
ALLEGRO_SEEK_SET \- seek relative to beginning of file
.IP \[bu] 2
ALLEGRO_SEEK_CUR \- seek relative to current file position
.IP \[bu] 2
ALLEGRO_SEEK_END \- seek relative to end of file
.PP
Returns true on success, false on failure.
errno is set to indicate the error.
.PP
After a successful seek, the end\-of\-file indicator is cleared and all
pushback bytes are forgotten.
.PP
On some platforms this function may not support large files.
.SH SEE ALSO
.PP
al_ftell(3), al_get_errno(3)