src/tiff/man/TIFFWarning.3tiff

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