Blame man/TIFFWarning.3tiff

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