afOpenFile
1.04 KB
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
38
39
40
41
42
afOpenFile opens a specified audio file and creates a file handle
structure which is used for subsequent calls to the Audio File
Library.
SYNOPSIS
#include <audiofile.h>
AFfilehandle afOpenFile(const char *path, const char *mode,
const AFfilesetup seutp);
PARAMETERS
path is the path to the file to be opened.
mode specifies a mode for opening the file (typically "r" or "w").
setup is ignored unless the mode specifies writing.
RETURN VALUE
afOpenFile returns, upon success, a valid AFfilehandle which can be
used in subsequent calls to the Audio File Library for reading or
writing.
Upon failure, afOpenFile returns a null file handle
(AF_NULL_FILEHANDLE).
afCloseFile is used to close the file when it is no longer needed.
ERRORS
afOpenFile can produce the following errors:
AF_BAD_OPEN (open failed)
AF_BAD_READ (read failed)
AF_BAD_WRITE (write failed)
AF_BAD_LSEEK (lseek failed)
AF_BAD_MALLOC (memory allocation failed)
AF_BAD_FILEFMT (unrecognized file format)
SEE ALSO
afCloseFile
afNewFileSetup
afInitFileFormat
afReadFrames
afWriteFrames