Blame html/man/TIFFWriteDirectory.3tiff.html

Packit 7838c8
Packit 7838c8
Packit 7838c8
<html>
Packit 7838c8
<head>
Packit 7838c8
<meta name="generator" content="groff -Thtml, see www.gnu.org">
Packit 7838c8
<meta name="Content-Style" content="text/css">
Packit 7838c8
<title>TIFFWriteDirectory</title>
Packit 7838c8
</head>
Packit 7838c8
<body>
Packit 7838c8
Packit 7838c8

TIFFWriteDirectory

Packit 7838c8
NAME
Packit 7838c8
SYNOPSIS
Packit 7838c8
DESCRIPTION
Packit 7838c8
RETURN VALUES
Packit 7838c8
DIAGNOSTICS
Packit 7838c8
SEE ALSO
Packit 7838c8
Packit 7838c8

Packit 7838c8
Packit 7838c8

NAME

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

TIFFWriteDirectory, TIFFRewriteDirectory,

Packit 7838c8
TIFFCheckpointDirectory − write the current directory
Packit 7838c8
in an open <small>TIFF</small> file

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

SYNOPSIS

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

#include <tiffio.h>

Packit 7838c8
Packit 7838c8

int TIFFWriteDirectory(TIFF *tif)

Packit 7838c8
int TIFFRewriteDirectory(TIFF *tif)
Packit 7838c8
int TIFFCheckpointDirectory(TIFF *tif)

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

DESCRIPTION

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

TIFFWriteDirectory will write the contents of the

Packit 7838c8
current directory to the file and setup to create a new
Packit 7838c8
subfile in the same file. Applications only need to call
Packit 7838c8
TIFFWriteDirectory when writing multiple subfiles to
Packit 7838c8
a single <small>TIFF</small> file. TIFFWriteDirectory
Packit 7838c8
is automatically called by TIFFClose and
Packit 7838c8
TIFFFlush to write a modified directory if the file
Packit 7838c8
is open for writing.

Packit 7838c8
Packit 7838c8

The TIFFRewriteDirectory function operates

Packit 7838c8
similarly to TIFFWriteDirectory, but can be called
Packit 7838c8
with directories previously read or written that already
Packit 7838c8
have an established location in the file. It will rewrite
Packit 7838c8
the directory, but instead of place it at it’s old
Packit 7838c8
location (as TIFFWriteDirectory would) it will place
Packit 7838c8
them at the end of the file, correcting the pointer from the
Packit 7838c8
preceeding directory or file header to point to it’s
Packit 7838c8
new location. This is particularly important in cases where
Packit 7838c8
the size of the directory and pointed to data has grown, so
Packit 7838c8
it won’t fit in the space available at the old
Packit 7838c8
location.

Packit 7838c8
Packit 7838c8

The TIFFCheckpointDirectory writes the current

Packit 7838c8
state of the tiff directory into the file to make what is
Packit 7838c8
currently in the file readable. Unlike
Packit 7838c8
TIFFWriteDirectory, TIFFCheckpointDirectory does not
Packit 7838c8
free up the directory data structures in memory, so they can
Packit 7838c8
be updated (as strips/tiles are written) and written again.
Packit 7838c8
Reading such a partial file you will at worst get a tiff
Packit 7838c8
read error for the first strip/tile encountered that is
Packit 7838c8
incomplete, but you will at least get all the valid data in
Packit 7838c8
the file before that. When the file is complete, just use
Packit 7838c8
TIFFWriteDirectory as usual to finish it off
Packit 7838c8
cleanly.

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

RETURN VALUES

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

1 is returned when the contents are successfully written

Packit 7838c8
to the file. Otherwise, 0 is returned if an error was
Packit 7838c8
encountered when writing the directory contents.

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

DIAGNOSTICS

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

All error messages are directed to the

Packit 7838c8
TIFFError(3TIFF) routine.

Packit 7838c8
Packit 7838c8

Error post-encoding before directory write. Before

Packit 7838c8
writing the contents of the current directory, any pending
Packit 7838c8
data are flushed. This message indicates that an error
Packit 7838c8
occurred while doing this.

Packit 7838c8
Packit 7838c8

Error flushing data before directory write. Before

Packit 7838c8
writing the contents of the current directory, any pending
Packit 7838c8
data are flushed. This message indicates that an error
Packit 7838c8
occurred while doing this.

Packit 7838c8
Packit 7838c8

Cannot write directory, out of space. There was

Packit 7838c8
not enough space to allocate a temporary area for the
Packit 7838c8
directory that was to be written.

Packit 7838c8
Packit 7838c8

Error writing directory count. A write error

Packit 7838c8
occurred when writing the count of fields in the
Packit 7838c8
directory.

Packit 7838c8
Packit 7838c8

Error writing directory contents. A write error

Packit 7838c8
occurred when writing the directory fields.

Packit 7838c8
Packit 7838c8

Error writing directory link. A write error

Packit 7838c8
occurred when writing the link to the next directory.

Packit 7838c8
Packit 7838c8

Error writing data for field "%s". A

Packit 7838c8
write error occurred when writing indirect data for the
Packit 7838c8
specified field.

Packit 7838c8
Packit 7838c8

Error writing TIFF header. A write error occurred

Packit 7838c8
when re-writing header at the front of the file.

Packit 7838c8
Packit 7838c8

Error fetching directory count. A read error

Packit 7838c8
occurred when fetching the directory count field for a
Packit 7838c8
previous directory. This can occur when setting up a link to
Packit 7838c8
the directory that is being written.

Packit 7838c8
Packit 7838c8

Error fetching directory link. A read error

Packit 7838c8
occurred when fetching the directory link field for a
Packit 7838c8
previous directory. This can occur when setting up a link to
Packit 7838c8
the directory that is being written.

Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

SEE ALSO

Packit 7838c8
Packit 7838c8
Packit 7838c8
       cols="2" cellspacing="0" cellpadding="0">
Packit 7838c8
Packit 7838c8
Packit 7838c8
Packit 7838c8

TIFFOpen(3TIFF), TIFFError(3TIFF),

Packit 7838c8
TIFFReadDirectory(3TIFF),
Packit 7838c8
TIFFSetDirectory(3TIFF), libtiff(3TIFF)

Packit 7838c8
Packit 7838c8

Libtiff library home page:

Packit 7838c8
http://www.simplesystems.org/libtiff/

Packit 7838c8
Packit 7838c8
Packit 7838c8

Packit 7838c8
</body>
Packit 7838c8
</html>