File: al_read_directory.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 (30 lines) | stat: -rw-r--r-- 769 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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_read_directory" "3" "" "Allegro reference manual" ""
.hy
.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)