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