ALPHALINUX5/util/ALPHALINUX5/man/man3/TIFFError.3t

   1 .\" $Header: /d1/sam/tiff/man/RCS/TIFFError.3t,v 1.14 1997/08/29 21:48:07 sam 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 3T "October 15, 1995"
  27 .SH NAME
  28 TIFFError, TIFFSetErrorHandler \- library error handling interface
  29 .SH SYNOPSIS
  30 .B "#include <tiffio.h>"
  31 .br
  32 .B "void TIFFError(const char* module, const char* fmt, ...)"
  33 .sp .5
  34 .B "#include <stdarg.h>"
  35 .br
  36 .B "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
  42 to (normally) write an error 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.
  49 The
  50 .I module
  51 parameter, if non-zero, is printed before the message; it typically
  52 is used to identify the software module in which an error
  53 is detected.
  54 .PP
  55 Applications that desire to capture control in the event of an error
  56 should use
  57 .IR TIFFSetErrorHandler
  58 to override the default error handler.
  59 A
  60 .SM NULL
  61 (0) error handling function may be installed to
  62 suppress error messages.
  63 .SH "RETURN VALUES"
  64 .IR TIFFSetErrorHandler
  65 returns a reference to the previous error handling function.
  66 .SH "SEE ALSO"
  67 .IR libtiff (3T),
  68 .IR TIFFWarning (3T),
  69 .IR printf (3S)