TIFFSetDirectory - set the current directory for an open TIFF file
Contents
Copyright
1988-2022, LibTIFF contributors
4.7 Apr 30, 2025 TIFFSETDIRECTORY(3tiff)
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. TIFFSetDirectory() only works with main-IFD chains because allways starts with the first main-IFD
and thus is able to reset the SubIFD reading chain to the main-IFD chain.
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. (see
MultiPageSubIFD)
Directory query functions TIFFCurrentDirectory(), TIFFCurrentDirOffset(), TIFFLastDirectory() and
TIFFNumberOfDirectories() retrieve information about directories in an open TIFF file. Be aware that
until a directory is not written to file AND read back, the query functions won't retrieve the correct
information!
Diagnostics
All error messages are directed to the TIFFErrorExtR() routine.
"%s:Errorfetchingdirectorycount":
An error was encountered while reading the "directory count" field.
"%s:Errorfetchingdirectorylink":
An error was encountered while reading the "link value" that points to the next directory in a file.
Name
TIFFSetDirectory - set the current directory for an open TIFF file
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.
See Also
TIFFquery (3tiff), TIFFOpen (3tiff), TIFFCreateDirectory (3tiff), TIFFCustomDirectory (3tiff),
TIFFWriteDirectory (3tiff), TIFFReadDirectory (3tiff), MultiPage/MultiImageTIFF, libtiff (3tiff)
Synopsis
#include <tiffio.h>
intTIFFSetDirectory(TIFF*tif,tdir_tdirnum)intTIFFSetSubDirectory(TIFF*tif,uint64_tdiroff)