summaryrefslogtreecommitdiff
path: root/docs/afSetErrorHandler
diff options
context:
space:
mode:
authorGraydon, Tracy <tracy.graydon@intel.com>2012-11-28 18:07:32 -0800
committerGraydon, Tracy <tracy.graydon@intel.com>2012-11-28 18:07:32 -0800
commitf9151a123d7943fb7e944a38b1aa835c03b0188e (patch)
treee7dfd84705f5db614d08449cb3e70c4dad74ff97 /docs/afSetErrorHandler
downloadaudiofile-f9151a123d7943fb7e944a38b1aa835c03b0188e.tar.gz
audiofile-f9151a123d7943fb7e944a38b1aa835c03b0188e.tar.bz2
audiofile-f9151a123d7943fb7e944a38b1aa835c03b0188e.zip
Diffstat (limited to 'docs/afSetErrorHandler')
-rw-r--r--docs/afSetErrorHandler28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/afSetErrorHandler b/docs/afSetErrorHandler
new file mode 100644
index 0000000..0ff5eb5
--- /dev/null
+++ b/docs/afSetErrorHandler
@@ -0,0 +1,28 @@
+afSetErrorHandler allows an alternate error handling routine to be
+specified.
+
+SYNOPSIS
+
+ #include <audiofile.h>
+
+ AFerrfunc afSetErrorHandler (AFerrfunc errorFunction);
+
+PARAMETERS
+
+errorFunction is a pointer to an error handling function which has the
+following prototype:
+ void error (long, char *, ...);
+
+RETURN VALUE
+
+The value returned from afSetErrorHandler is a pointer to the previous
+error handling function.
+
+DESCRIPTION
+
+The afSetErrorHandler() library function allows the user to override
+the default error handling function.
+
+The arguments are a long indicating an error code and a string (which
+may have printf-style formatting) followed by a variable argument list
+which contains any arguments for the format string.