10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->
13666N/A<!--ARC : LSARC 2003/085 libtiff, libjpeg, and libpng-->
10139N/A<!ENTITY synp-tt "SYNOPSIS">
10139N/A<!ENTITY cmd "TIFFWriteEncodedStrip">
10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
10139N/A%commonents;
10139N/A<!ENTITY % gnomecommonents SYSTEM "gnomecommon.ent">
10139N/A%gnomecommonents;
10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
10139N/A%booktitles;
10139N/A<!ENTITY suncopy "Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.">
10139N/A]>
10139N/A<?Pub UDT _bookmark _target>
10139N/A<?Pub Inc>
10139N/A<?PubInc>
10139N/A<refentry id="TIFFWriteEncodedStrip-3tiff">
10139N/A<!-- %Z%%M% %I% %E% SMI; -->
10139N/A<refmeta><refentrytitle>TIFFWriteEncodedStrip</refentrytitle><manvolnum>3tiff
10139N/A</manvolnum>
10139N/A<refmiscinfo class="date">05 Apr 2004</refmiscinfo>
10139N/A<refmiscinfo class="sectdesc">&man3;</refmiscinfo>
10139N/A<refmiscinfo class="software">&release;</refmiscinfo>
10139N/A<refmiscinfo class="arch">generic</refmiscinfo>
10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
10139N/A</refmeta>
10139N/A<indexterm><primary>TIFFWriteEncodedStrip</primary></indexterm><indexterm>
10139N/A<primary>c<?Pub Caret1>ompress and write a strip of data to an open TIFF file
10139N/A</primary></indexterm>
10139N/A<refnamediv id="TIFFWriteEncodedStrip-3tiff-name"><refname>TIFFWriteEncodedStrip
10139N/A</refname><refpurpose>compress and write a strip of data to an open TIFF file
10139N/A</refpurpose></refnamediv>
10139N/A<refsect1 id="TIFFWriteEncodedStrip-3tiff-synp"><title>&synp-tt;</title>
10139N/A<programlisting>#include &lt;tiffio.h>
10139N/Atsize_t TIFFWriteEncodedStrip(TIFF* tif, tstrip_t strip,
10139N/Atdata_t buf, tsize_t size)</programlisting>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFWriteEncodedStrip-3tiff-desc"><title>&desc-tt;</title>
10139N/A<para>Compress <literal>size</literal> bytes of raw data from <literal>buf
10139N/A</literal> and write the result to the specified strip, replacing any previously
10139N/Awritten data. Note that the value of <literal>strip</literal> is a &ldquo;raw
10139N/Astrip number&rdquo;. That is, the caller must take into account whether or
10139N/Anot the data is organized in separate planes (PlanarConfiguration=2).</para>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFWriteEncodedStrip-3tiff-exde"><title>&exde-tt;</title>
10139N/A<para>The library writes encoded data using the native machine byte order.
10139N/ACorrectly implemented TIFF readers are expected to do any necessary byte-swapping
10139N/Ato correctly process image data with <literal>BitsPerSample</literal> greater
10139N/Athan 8.</para>
10139N/A<para>The strip number must be valid according to the current settings of
10139N/Athe <literal>ImageLength</literal> and <literal>RowsPerStrip</literal> tags.
10139N/AAn image may be dynamically grown by increasing the value of <literal>ImageLength
10139N/A</literal> prior to each call to <literal>TIFFWriteEncodedStrip</literal>.
10139N/A</para>
10139N/A<refsect2 id="TIFFWriteEncodedStrip-3tiff-exde-diags">
10139N/A<title>Diagnostics</title>
10139N/A<para>All error messages are directed to the <literal>TIFFError(3tiff)</literal>
10139N/Aroutine.</para>
10139N/A<variablelist>
10139N/A<varlistentry><term>%s: File not open for writing.</term><listitem><para>
10139N/AThe file was opened for reading, not writing.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term>Can not write scanlines to a tiled image.</term><listitem>
10139N/A<para>The image is assumed to be organized in tiles because the <literal>
10139N/ATileWidth</literal> and <literal>TileLength</literal> tags have been set with <literal>
10139N/ATIFFSetField(3tiff)</literal>.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term>%s: Must set "ImageWidth" before writing data.</term>
10139N/A<listitem><para>The image width has not been set before the first write. See <literal>
10139N/ATIFFSetField(3tiff)</literal> for information on how to do this.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term>%s: Must set "PlanarConfiguration" before writing data.
10139N/A</term><listitem><para>The organization of data has not been defined before
10139N/Athe first write. See <literal>TIFFSetField(3tiff)</literal> for information on
10139N/Ahow to do this.</para>
10139N/A</listitem></varlistentry>
10139N/A<varlistentry><term>%s: No space for strip arrays".</term><listitem><para>
10139N/AThere was not enough space for the arrays that hold strip offsets and byte
10139N/Acounts.</para>
10139N/A</listitem></varlistentry>
10139N/A</variablelist></refsect2>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFWriteEncodedStrip-3tiff-rtrn"><title>&rtrn-tt;</title>
10139N/A<para>-1 is returned if an error was encountered. Otherwise, the value of <literal>
10139N/Asize</literal> is returned.</para>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFWriteEncodedStrip-3tiff-attr"><title>&attr-tt;</title>
10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
10139N/Afor descriptions of the following attributes:</para>
10139N/A<informaltable frame="all">
10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
10139N/A<colspec colname="COLSPEC1" colwidth="1*">
10139N/A<thead>
10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
10139N/A</thead>
10139N/A<tbody>
18745N/A<row><entry><para>Availability</para></entry><entry><para>image/library/libtiff</para></entry>
10139N/A</row>
10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
13623N/Acolname="COLSPEC1"><para>Uncommitted</para></entry></row>
10139N/A</tbody>
10139N/A</tgroup>
10139N/A</informaltable>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFWriteEncodedStrip-3tiff-also"><title>&also-tt;</title>
10139N/A<!--Reference to another man page-->
10139N/A<!--Reference to a Help manual-->
10139N/A<!--Reference to a book.-->
10139N/A<para><citerefentry><refentrytitle>libtiff</refentrytitle><manvolnum>3</manvolnum>
10139N/A</citerefentry>, <citerefentry><refentrytitle>TIFFOpen</refentrytitle><manvolnum>
10139N/A3tiff</manvolnum></citerefentry>, <citerefentry><refentrytitle>TIFFWriteRawStrip
10139N/A</refentrytitle><manvolnum>3tiff</manvolnum></citerefentry>, <citerefentry>
10139N/A<refentrytitle>TIFFWriteScanline</refentrytitle><manvolnum>3tiff</manvolnum>
10139N/A</citerefentry></para>
10139N/A</refsect1>
10139N/A<refsect1 id="TIFFWriteEncodedStrip-3tiff-note"><title>&note-tt;</title>
10139N/A<para>This man page was originally written by Sam Leffler. Updated by Breda
10139N/AMcColgan, Sun Microsystems Inc., 2004.</para>
10139N/A</refsect1>
10139N/A</refentry>
10139N/A<?Pub *0000005999>