Oreon-Lime-R2/audiofile/audiofile-0.3.6/docs/afSetErrorHandler.3

52 lines
1.8 KiB
Groff

'\" t
.\" Title: afSetErrorHandler
.\" 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 "AFSETERRORHANDLER" "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"
afSetErrorHandler \- install a custom error handling routine
.SH "SYNOPSIS"
.sp
.nf
#include <audiofile\&.h>
.fi
.sp
.nf
AFerrfunc afSetErrorHandler (AFerrfunc errorFunction);
.fi
.SH "PARAMETERS"
.sp
\fIerrorFunction\fR is a pointer to an error handling function\&.
.SH "DESCRIPTION"
.sp
afSetErrorHandler allows the user to install an error handling function overriding the default function\&.
.SH "RETURN VALUE"
.sp
The value returned from afSetErrorHandler is a pointer to the previous error handling function\&.
.SH "AUTHOR"
.sp
Michael Pruett <michael@68k\&.org>