projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 8414a40c VZ |
1 | .\" $Id: TIFFSetDirectory.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 TIFFSetDirectory 3TIFF "October 15, 1995" "libtiff" | |
| 27 | .SH NAME | |
| 28 | TIFFSetDirectory, TIFFSetSubDirectory \- set the current directory for an open | |
| 29 | .SM TIFF | |
| 30 | file | |
| 31 | .SH SYNOPSIS | |
| 32 | .B "#include <tiffio.h>" | |
| 33 | .sp | |
| 34 | .BI "int TIFFSetDirectory(TIFF *" tif ", tdir_t " dirnum ")" | |
| 35 | .br | |
| 36 | .BI "int TIFFSetSubDirectory(TIFF *" tif ", uint32 " diroff ")" | |
| 37 | .SH DESCRIPTION | |
| 38 | .I TIFFSetDirectory | |
| 39 | changes the current directory and reads its contents with | |
| 40 | .IR TIFFReadDirectory . | |
| 41 | The parameter | |
| 42 | .I dirnum | |
| 43 | specifies the subfile/directory as an integer number, with the first directory | |
| 44 | numbered zero. | |
| 45 | .PP | |
| 46 | .I TIFFSetSubDirectory | |
| 47 | acts like | |
| 48 | .IR TIFFSetDirectory , | |
| 49 | except the directory is specified as a file offset instead of an index; this | |
| 50 | is required for accessing subdirectories linked through a | |
| 51 | .I SubIFD | |
| 52 | tag. | |
| 53 | .SH "RETURN VALUES" | |
| 54 | On successful return 1 is returned. Otherwise, 0 is returned if | |
| 55 | .I dirnum | |
| 56 | or | |
| 57 | .I diroff | |
| 58 | specifies a non-existent directory, or if an error was encountered while | |
| 59 | reading the directory's contents. | |
| 60 | .SH DIAGNOSTICS | |
| 61 | All error messages are directed to the | |
| 62 | .IR TIFFError (3TIFF) | |
| 63 | routine. | |
| 64 | .PP | |
| 65 | .BR "%s: Error fetching directory count" . | |
| 66 | An error was encountered while reading the ``directory count'' field. | |
| 67 | .PP | |
| 68 | .BR "%s: Error fetching directory link" . | |
| 69 | An error was encountered while reading the ``link value'' that points to the | |
| 70 | next directory in a file. | |
| 71 | .SH "SEE ALSO" | |
| 72 | .IR TIFFCurrentDirectory (3TIFF), | |
| 73 | .IR TIFFOpen (3TIFF), | |
| 74 | .IR TIFFReadDirectory (3TIFF), | |
| 75 | .IR TIFFWriteDirectory (3TIFF), | |
| 76 | .IR libtiff (3TIFF) | |
| 77 | .PP | |
| 78 | Libtiff library home page: | |
| 79 | .BR http://www.remotesensing.org/libtiff/ |