TIFFSetDirectory (3)

Leading comments

$Id: TIFFSetDirectory.3tiff,v 1.3 2016-09-25 20:05:50 bfriesen Exp $

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 use...

(The comments found at the beginning of the groff file "man3/TIFFSetDirectory.3tiff".)

NAME

TIFFSetDirectory, TIFFSetSubDirectory - set the current directory for an open file

SYNOPSIS

#include <tiffio.h>

int TIFFSetDirectory(TIFF *tif, tdir_t dirnum)
int TIFFSetSubDirectory(TIFF *tif, uint32 diroff)

DESCRIPTION

TIFFSetDirectory changes the current directory and reads its contents with TIFFReadDirectory. The parameter dirnum specifies the subfile/directory as an integer number, with the first directory numbered zero.

TIFFSetSubDirectory acts like TIFFSetDirectory, except the directory is specified as a file offset instead of an index; this is required for accessing subdirectories linked through a SubIFD tag.

RETURN VALUES

On successful return 1 is returned. Otherwise, 0 is returned if dirnum or diroff specifies a non-existent directory, or if an error was encountered while reading the directory's contents.

DIAGNOSTICS

All error messages are directed to the TIFFError(3TIFF) routine.

%s: Error fetching directory count. An error was encountered while reading the ``directory count'' field.

%s: Error fetching directory link. An error was encountered while reading the ``link value'' that points to the next directory in a file.

SEE ALSO

TIFFCurrentDirectory(3TIFF), TIFFOpen(3TIFF), TIFFReadDirectory(3TIFF), TIFFWriteDirectory(3TIFF), libtiff(3TIFF)

Libtiff library home page: www.simplesystems.org/libtiff