projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 8414a40c VZ |
1 | .\" $Id: TIFFWarning.3tiff,v 1.2 2005/11/02 11:07:18 dron 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 TIFFWarning 3TIFF "October 15, 1995" "libtiff" | |
| 27 | .SH NAME | |
| 28 | TIFFWarning, TIFFSetWarningHandler \- library warning interface | |
| 29 | .SH SYNOPSIS | |
| 30 | .B "#include <tiffio.h>" | |
| 31 | .sp | |
| 32 | .BI "void TIFFWarning(const char *" module ", const char *" fmt ", " ... ")" | |
| 33 | .sp | |
| 34 | .B "#include <stdargh.h>" | |
| 35 | .sp | |
| 36 | .BI "typedef void (*TIFFWarningHandler)(const char *" module ", const char *" fmt ", va_list " ap ");" | |
| 37 | .sp | |
| 38 | .BI "TIFFWarningHandler TIFFSetWarningHandler(TIFFWarningHandler " handler ");" | |
| 39 | .SH DESCRIPTION | |
| 40 | .I TIFFWarning | |
| 41 | invokes the library-wide warning handler function to (normally) write a | |
| 42 | warning 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. The | |
| 49 | .I module | |
| 50 | parameter is interpreted as a string that, if non-zero, should be printed | |
| 51 | before the message; it typically is used to identify the software module in | |
| 52 | which a warning is detected. | |
| 53 | .PP | |
| 54 | Applications that desire to capture control in the event of a warning should | |
| 55 | use | |
| 56 | .IR TIFFSetWarningHandler | |
| 57 | to override the default warning handler. | |
| 58 | A | |
| 59 | .SM NULL | |
| 60 | (0) warning handler function may be installed to suppress error messages. | |
| 61 | .SH "RETURN VALUES" | |
| 62 | .IR TIFFSetWarningHandler | |
| 63 | returns a reference to the previous error handling function. | |
| 64 | .SH "SEE ALSO" | |
| 65 | .BR TIFFError (3TIFF), | |
| 66 | .BR libtiff (3TIFF), | |
| 67 | .BR printf (3) | |
| 68 | .PP | |
| 69 | Libtiff library home page: | |
| 70 | .BR http://www.remotesensing.org/libtiff/ |