src/tiff/man/TIFFWriteRawStrip.3tiff

   1 .\" $Id: TIFFWriteRawStrip.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 TIFFWriteRawstrip 3TIFF "October 15, 1995" "libtiff"
  27 .SH NAME
  28 TIFFWriteRawStrip \- write a strip of raw data to an open
  29 .SM TIFF
  30 file
  31 .SH SYNOPSIS
  32 .B "#include <tiffio.h>"
  33 .sp
  34 .BI "tsize_t TIFFWriteRawStrip(TIFF *" tif ", tstrip_t " strip ", tdata_t " buf ", tsize_t " size ")"
  35 .SH DESCRIPTION
  36 Append
  37 .I size
  38 bytes of raw data to the specified strip.
  39 .SH NOTES
  40 The strip number must be valid according to the current settings of the
  41 .I ImageLength
  42 and
  43 .I RowsPerStrip
  44 tags.
  45 An image may be dynamically grown by increasing the value of
  46 .I ImageLength
  47 prior to each call to
  48 .IR TIFFWriteRawStrip .
  49 .SH "RETURN VALUES"
  50 \-1 is returned if an error occurred.
  51 Otherwise, the value of
  52 .IR size
  53 is returned.
  54 .SH DIAGNOSTICS
  55 All error messages are directed to the
  56 .BR TIFFError (3TIFF)
  57 routine.
  58 .PP
  59 \fB%s: File not open for writing\fP.
  60 The file was opened for reading, not writing.
  61 .PP
  62 \fBCan not write scanlines to a tiled image\fP. The image is assumed to be
  63 organized in tiles because the
  64 .I TileWidth
  65 and
  66 .I TileLength
  67 tags have been set with
  68 .BR TIFFSetField (3TIFF).
  69 .PP
  70 \fB%s: Must set "ImageWidth" before writing data\fP.
  71 The image's width has not be set before the first write.
  72 See
  73 .BR TIFFSetField (3TIFF)
  74 for information on how to do this.
  75 .PP
  76 \fB%s: Must set "PlanarConfiguration" before writing data\fP.
  77 The organization of data has not be defined before the first write.
  78 See
  79 .BR TIFFSetField (3TIFF)
  80 for information on how to do this.
  81 .PP
  82 \fB%s: No space for strip arrays"\fP.
  83 There was not enough space for the arrays that hold strip
  84 offsets and byte counts.
  85 .PP
  86 \fB%s: Strip %d out of range, max %d\fP.
  87 The specified strip is not a valid strip according to the
  88 currently specified image dimensions.
  89 .SH "SEE ALSO"
  90 .BR TIFFOpen (3TIFF),
  91 .BR TIFFWriteEncodedStrip (3TIFF),
  92 .BR TIFFWriteScanline (3TIFF),
  93 .BR libtiff (3TIFF)
  94 .PP
  95 Libtiff library home page:
  96 .BR http://www.remotesensing.org/libtiff/