src/tiff/man/TIFFError.3tiff

   1 .\" $Id: TIFFError.3tiff,v 1.2 2005/11/02 11:07:18 dron Exp $
   2 .\"
   3 .\" Copyright (c) 1988-1997 Sam Leffler
   4 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
   5 .\"
   6 .\" Permission to use, copy, modify, distribute, and sell this software and
   7 .\" its documentation for any purpose is hereby granted without fee, provided
   8 .\" that (i) the above copyright notices and this permission notice appear in
   9 .\" all copies of the software and related documentation, and (ii) the names of
  10 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  11 .\" publicity relating to the software without the specific, prior written
  12 .\" permission of Sam Leffler and Silicon Graphics.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  16 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  17 .\"
  18 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  19 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  20 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  21 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  22 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  23 .\" OF THIS SOFTWARE.
  24 .\"
  25 .if n .po 0
  26 .TH TIFFError 3TIFF "October 15, 1995" "libtiff"
  27 .SH NAME
  28 TIFFError, TIFFSetErrorHandler \- library error handling interface
  29 .SH SYNOPSIS
  30 .B "#include <tiffio.h>"
  31 .sp
  32 .BI "void TIFFError(const char *" module ", const char *" fmt ", " ... ")"
  33 .sp
  34 .B "#include <stdarg.h>"
  35 .sp
  36 .BI "typedef void (*TIFFErrorHandler)(const char *" module ", const char *" fmt ", va_list " ap ");"
  37 .br
  38 .B "TIFFErrorHandler TIFFSetErrorHandler(TIFFErrorHandler handler);"
  39 .SH DESCRIPTION
  40 .I TIFFError
  41 invokes the library-wide error handling function to (normally) write an error
  42 message to the
  43 .BR stderr .
  44 The
  45 .I fmt
  46 parameter is a
  47 .IR printf (3S)
  48 format string, and any number arguments can be supplied. The
  49 .I module
  50 parameter, if non-zero, is printed before the message; it typically is used to
  51 identify the software module in which an error is detected.
  52 .PP
  53 Applications that desire to capture control in the event of an error should
  54 use
  55 .IR TIFFSetErrorHandler
  56 to override the default error handler.
  57 A
  58 .SM NULL
  59 (0) error handling function may be installed to suppress error messages.
  60 .SH "RETURN VALUES"
  61 .IR TIFFSetErrorHandler
  62 returns a reference to the previous error handling function.
  63 .SH "SEE ALSO"
  64 .BR TIFFWarning (3TIFF),
  65 .BR libtiff (3TIFF),
  66 .BR printf (3)
  67 .PP
  68 Libtiff library home page:
  69 .BR http://www.remotesensing.org/libtiff/