[wxWidgets.git] / src / tiff / man / TIFFError.3tiff

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