Current Directory: /usr/share/doc/libtiff-devel/html/man
Viewing File: /usr/share/doc/libtiff-devel/html/man/TIFFStrileQuery.3tiff.html
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Sun Nov 2 19:00:00 2025 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>TIFFSTRILEQUERY</title>
</head>
<body>
<h1 align="center">TIFFSTRILEQUERY</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#DIAGNOSTICS">DIAGNOSTICS</a><br>
<a href="#NOTE">NOTE</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#COPYRIGHT">COPYRIGHT</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">TIFFStrileQuery
− get strile byte count and offset</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<pre style="margin-left:15%; margin-top: 1em">#include <tiffio.h></pre>
<p style="margin-left:11%;"><b>uint64_t
TIFFGetStrileByteCount(TIFF *tif, uint32_t strile); <br>
uint64_t TIFFGetStrileOffset(TIFF *tif, uint32_t strile);
<br>
uint64_t TIFFGetStrileByteCountWithErr(TIFF *tif, uint32_t
strile, int <br>
*pbErr); <br>
uint64_t TIFFGetStrileOffsetWithErr(TIFF *tif, uint32_t
strile, int <br>
*pbErr);</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">Make defer
strile offset/bytecount loading available at runtime and add
per−strile offset/bytecount loading capabilities. Part
of this commit makes the behaviour that was previously met
when <b>libtiff</b> was compiled with
<b>−DDEFER_STRILE_LOAD</b> available for default
builds.</p>
<p style="margin-left:11%; margin-top: 1em">When specifying
the new <b>D</b> (Deferred) <i>TIFFOpen()</i> flag, the
loading of strile offset/bytecount is defered. In that mode,
the <b>StripOffsets</b> / <b>StripByteCounts</b> or
<b>TileOffsets</b> / <b>TileByteCounts</b> arrays are only
loaded when first accessed. This can speed−up the
opening of files stored on the network when just metadata
retrieval is needed.</p>
<p style="margin-left:11%; margin-top: 1em">Another
addition is the capability of loading only the values of the
offset/bytecount of the strile of interest instead of the
whole array. This is enabled with the new <b>O</b>
(Ondemand) flag of <i>TIFFOpen()</i> (which implies
<b>D</b>).</p>
<p style="margin-left:11%; margin-top: 1em">The public
<i>TIFFGetStrileOffset()</i>,
<i>TIFFGetStrileOffsetWithErr()</i>,
<i>TIFFGetStrileByteCount()</i> and
<i>TIFFGetStrileByteCountWithErr()</i> functions have been
added to API. They are of particular interest when using
sparse files (with <b>offset == bytecount == 0</b>) and you
want to detect if a strile is present or not without
decompressing the data, or updating an existing sparse
file.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetStrileByteCount()</i>
returns the value of the TileByteCounts / StripByteCounts
array for the specified tile/strile.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetStrileByteCountWithErr()</i>
additionally provides <i>pbErr</i> as an <i>int</i> pointer
to an error return variable, which is set to "0"
for successful return or to "1" for an error
return.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetStrileOffset()</i>
returns the value of the TileOffsets / StripOffsets array
for the specified tile/strile.</p>
<p style="margin-left:11%; margin-top: 1em"><i>TIFFGetStrileOffsetWithErr()</i>
additionally provides <i>pbErr</i> as an <i>int</i> pointer
to an error return variable, which is set to "0"
for successful return or to "1" for an error
return.</p>
<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">All error
messages are directed to the <i>TIFFErrorExtR()</i> routine.
Likewise, warning messages are directed to the
<i>TIFFWarningExtR()</i> routine.</p>
<h2>NOTE
<a name="NOTE"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">This
functionality was introduced with libtiff 4.1.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><i>libtiff</i>
(3tiff), <i>TIFFOpen</i> (3tiff),
<i>TIFFDeferStrileArrayWriting</i> (3tiff)</p>
<h2>AUTHOR
<a name="AUTHOR"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">LibTIFF
contributors</p>
<h2>COPYRIGHT
<a name="COPYRIGHT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">1988-2025,
LibTIFF contributors</p>
<hr>
</body>
</html>