File: al_open_directory.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 (23 lines) | stat: -rw-r--r-- 491 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
.TH al_open_directory 3 "" "Allegro reference manual"
.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)