src/tiff/man/TIFFReadRawStrip.3tiff

   1 .\" $Id: TIFFReadRawStrip.3tiff,v 1.2 2005-11-02 11:07:18 dron Exp $
   2 .\"
   3 .\" Copyright (c) 1988-1997 Sam Leffler
   4 .\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
   5 .\"
   6 .\" Permission to use, copy, modify, distribute, and sell this software and
   7 .\" its documentation for any purpose is hereby granted without fee, provided
   8 .\" that (i) the above copyright notices and this permission notice appear in
   9 .\" all copies of the software and related documentation, and (ii) the names of
  10 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  11 .\" publicity relating to the software without the specific, prior written
  12 .\" permission of Sam Leffler and Silicon Graphics.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  16 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  17 .\"
  18 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  19 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  20 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  21 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  22 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  23 .\" OF THIS SOFTWARE.
  24 .\"
  25 .if n .po 0
  26 .TH TIFFReadRawStrip 3TIFF "October 15, 1995" "libtiff"
  27 .SH NAME
  28 TIFFReadRawStrip \- return the undecoded contents of a strip of data from an
  29 open
  30 .SM TIFF
  31 file
  32 .SH SYNOPSIS
  33 .B "#include <tiffio.h>"
  34 .sp
  35 .BI "tsize_t TIFFReadRawStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")"
  36 .SH DESCRIPTION
  37 Read the contents of the specified strip into the (user supplied) data buffer.
  38 Note that the value of
  39 .I strip
  40 is a ``raw strip number.'' That is, the caller must take into account whether
  41 or not the data is organized in separate planes (\c
  42 .IR PlanarConfiguration =2).
  43 To read a full strip of data the data buffer should typically be at least as
  44 large as the number returned by
  45 .IR TIFFStripSize .
  46 .SH "RETURN VALUES"
  47 The actual number of bytes of data that were placed in
  48 .I buf
  49 is returned;
  50 .IR TIFFReadEncodedStrip
  51 returns \-1 if an error was encountered.
  52 .SH DIAGNOSTICS
  53 All error messages are directed to the
  54 .BR TIFFError (3TIFF)
  55 routine.
  56 .SH "SEE ALSO"
  57 .BR TIFFOpen (3TIFF),
  58 .BR TIFFReadEncodedStrip (3TIFF),
  59 .BR TIFFReadScanline (3TIFF),
  60 .BR TIFFStripSize (3TIFF),
  61 .BR libtiff (3TIFF)
  62 .PP
  63 Libtiff library home page:
  64 .BR http://www.remotesensing.org/libtiff/