94 lines
2.1 KiB
Groff
94 lines
2.1 KiB
Groff
'\" t
|
|
.\" Title: afCloseFile
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
|
.\" Date: 03/06/2013
|
|
.\" Manual: \ \&
|
|
.\" Source: Audio File Library 0.3.6
|
|
.\" Language: English
|
|
.\"
|
|
.TH "AFCLOSEFILE" "3" "03/06/2013" "Audio File Library 0\&.3\&.6" "\ \&"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
afCloseFile \- close an open audio file
|
|
.SH "SYNOPSIS"
|
|
.sp
|
|
.nf
|
|
#include <audiofile\&.h>
|
|
.fi
|
|
.sp
|
|
.nf
|
|
int afCloseFile(AFfilehandle file);
|
|
.fi
|
|
.SH "PARAMETERS"
|
|
.sp
|
|
file is a valid file handle created by \fBafOpenFile\fR(3)\&.
|
|
.SH "DESCRIPTION"
|
|
.sp
|
|
afCloseFile closes the audio file \fIfile\fR, updating the file if it was opened for writing\&.
|
|
.SH "RETURN VALUE"
|
|
.sp
|
|
afCloseFile returns 0 if the file was closed properly and \-1 if an error occurred while closing the file\&.
|
|
.SH "ERRORS"
|
|
.sp
|
|
afCloseFile can generate these possible errors:
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
|
|
AF_BAD_FILEHANDLE
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
|
|
AF_BAD_LSEEK
|
|
.RE
|
|
.sp
|
|
.RS 4
|
|
.ie n \{\
|
|
\h'-04'\(bu\h'+03'\c
|
|
.\}
|
|
.el \{\
|
|
.sp -1
|
|
.IP \(bu 2.3
|
|
.\}
|
|
|
|
AF_BAD_WRITE
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
.sp
|
|
\fBafOpenFile\fR(3)
|
|
.SH "AUTHOR"
|
|
.sp
|
|
Michael Pruett <michael@68k\&.org>
|