File: al_read_directory.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 (27 lines) | stat: -rw-r--r-- 714 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
.TH "al_read_directory" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_read_directory \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

ALLEGRO_FS_ENTRY\ *al_read_directory(ALLEGRO_FS_ENTRY\ *e)
\f[]
.fi
.SH DESCRIPTION
.PP
Reads the next directory item and returns a filesystem entry for it.
.PP
Returns NULL if there are no more entries or if an error occurs.
Call al_destroy_fs_entry(3) on the returned entry when you are done with
it.
.PP
This function will ignore any files or directories named \f[C]\&.\f[] or
\f[C]\&..\f[] which may exist on certain platforms and may signify the
current and the parent directory.
.SH SEE ALSO
.PP
al_open_directory(3), al_close_directory(3)