File: al_open_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 (26 lines) | stat: -rw-r--r-- 553 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
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_open_directory" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_open_directory \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_open_directory(ALLEGRO_FS_ENTRY\ *e)
\f[]
.fi
.SH DESCRIPTION
.PP
Opens a directory entry object.
You must call this before using al_read_directory(3) on an entry and you
must call al_close_directory(3) when you no longer need it.
.PP
Returns true on success.
.SH SEE ALSO
.PP
al_read_directory(3), al_close_directory(3)