linux man page for tiffreadencodedstrip

TIFFReadEncodedStrip(3tiff)				 Introduction to Library Functions			       TIFFReadEncodedStrip(3tiff)

NAME
       TIFFReadEncodedStrip - read and decode a strip of data from an open TIFF file

SYNOPSIS
       #include <tiffio.h>
       tsize_t TIFFReadEncodedStrip(TIFF* tif, tstrip_t strip,
       tdata_t buf, tsize_t size)

DESCRIPTION
       Read the specified strip of data and place up to size bytes of decompressed information in the user-supplied data buffer.

EXTENDED DESCRIPTION
       The  value  of  strip  is a "raw strip number". That is, the caller must take into account whether or not the data is organized in separate
       planes (PlanarConfiguration=2). To read a full strip of data, the data buffer should typically be at least as large as the  value  returned
       by TIFFStripSize(3tiff).

       The  library  attempts to hide bit- and byte-ordering differences between the image and the native machine by converting data to the native
       machine order. Bit reversal is performed if the FillOrder tag is opposite to the native machine bit order. 16- and 32-bit samples are auto-
       matically byte-swapped if the file was written with a byte order opposite to the native machine byte order.

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

RETURN VALUES
       Returns the actual number of bytes of data that were placed in buf. Returns -1 if an error was encountered.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWTiff			   |
       +-----------------------------+-----------------------------+
       |Interface stability	     |External			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       libtiff(3), TIFFOpen(3tiff), TIFFReadRawStrip(3tiff), TIFFReadScanline(3tiff)

NOTES
       This man page was originally written by Sam Leffler. Updated by Breda McColgan, Sun Microsystems Inc., 2004.

SunOS 5.10							    05 Apr 2004 				       TIFFReadEncodedStrip(3tiff)