roentgen b75cab
.\" $Id: TIFFWarning.3tiff,v 1.3 2012-06-01 22:02:44 fwarmerdam Exp $
roentgen b75cab
.\"
roentgen b75cab
.\" Copyright (c) 1988-1997 Sam Leffler
roentgen b75cab
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
roentgen b75cab
.\"
roentgen b75cab
.\" Permission to use, copy, modify, distribute, and sell this software and 
roentgen b75cab
.\" its documentation for any purpose is hereby granted without fee, provided
roentgen b75cab
.\" that (i) the above copyright notices and this permission notice appear in
roentgen b75cab
.\" all copies of the software and related documentation, and (ii) the names of
roentgen b75cab
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
roentgen b75cab
.\" publicity relating to the software without the specific, prior written
roentgen b75cab
.\" permission of Sam Leffler and Silicon Graphics.
roentgen b75cab
.\" 
roentgen b75cab
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
roentgen b75cab
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
roentgen b75cab
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
roentgen b75cab
.\" 
roentgen b75cab
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
roentgen b75cab
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
roentgen b75cab
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
roentgen b75cab
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
roentgen b75cab
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
roentgen b75cab
.\" OF THIS SOFTWARE.
roentgen b75cab
.\"
roentgen b75cab
.if n .po 0
roentgen b75cab
.TH TIFFWarning 3TIFF "October 15, 1995" "libtiff"
roentgen b75cab
.SH NAME
roentgen b75cab
TIFFWarning, TIFFSetWarningHandler \- library warning interface
roentgen b75cab
.SH SYNOPSIS
roentgen b75cab
.B "#include <tiffio.h>"</tiffio.h>
roentgen b75cab
.sp
roentgen b75cab
.BI "void TIFFWarning(const char *" module ", const char *" fmt ", " ... ")"
roentgen b75cab
.sp
roentgen b75cab
.B "#include <stdarg.h>"</stdarg.h>
roentgen b75cab
.sp
roentgen b75cab
.BI "typedef void (*TIFFWarningHandler)(const char *" module ", const char *" fmt ", va_list " ap ");"
roentgen b75cab
.sp
roentgen b75cab
.BI "TIFFWarningHandler TIFFSetWarningHandler(TIFFWarningHandler " handler ");"
roentgen b75cab
.SH DESCRIPTION
roentgen b75cab
.I TIFFWarning
roentgen b75cab
invokes the library-wide warning handler function to (normally) write a
roentgen b75cab
warning message to the
roentgen b75cab
.BR stderr .
roentgen b75cab
The
roentgen b75cab
.I fmt
roentgen b75cab
parameter is a
roentgen b75cab
.IR printf (3S)
roentgen b75cab
format string, and any number arguments can be supplied. The
roentgen b75cab
.I module
roentgen b75cab
parameter is interpreted as a string that, if non-zero, should be printed
roentgen b75cab
before the message; it typically is used to identify the software module in
roentgen b75cab
which a warning is detected.
roentgen b75cab
.PP
roentgen b75cab
Applications that desire to capture control in the event of a warning should
roentgen b75cab
use
roentgen b75cab
.IR TIFFSetWarningHandler
roentgen b75cab
to override the default warning handler.
roentgen b75cab
A
roentgen b75cab
.SM NULL
roentgen b75cab
(0) warning handler function may be installed to suppress error messages.
roentgen b75cab
.SH "RETURN VALUES"
roentgen b75cab
.IR TIFFSetWarningHandler
roentgen b75cab
returns a reference to the previous error handling function.
roentgen b75cab
.SH "SEE ALSO"
roentgen b75cab
.BR TIFFError (3TIFF),
roentgen b75cab
.BR libtiff (3TIFF),
roentgen b75cab
.BR printf (3)
roentgen b75cab
.PP
roentgen b75cab
Libtiff library home page:
roentgen b75cab
.BR http://www.remotesensing.org/libtiff/