src/tiff/man/TIFFFlush.3tiff

   1 .\" $Id: TIFFFlush.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 TIFFFlush 3TIFF "December 16, 1991" "libtiff"
  27 .SH NAME
  28 TIFFFlush, TIFFFlushData \- flush pending writes to an open
  29 .SM TIFF
  30 file
  31 .SH SYNOPSIS
  32 .B "#include <tiffio.h>"
  33 .sp
  34 .BI "int TIFFFlush(TIFF *" tif ")"
  35 .br
  36 .BI "int TIFFFlushData(TIFF *" tif ")"
  37 .SH DESCRIPTION
  38 .IR TIFFFlush
  39 causes any pending writes for the specified file (including writes for the
  40 current directory) to be done. In normal operation this call is never needed \-
  41 the library automatically does any flushing required.
  42 .PP
  43 .IR TIFFFlushData
  44 flushes any pending image data for the specified file to be written out;
  45 directory-related data are not flushed. In normal operation this call is never
  46 needed \- the library automatically does any flushing required.
  47 .SH "RETURN VALUES"
  48 0 is returned if an error is encountered, otherwise 1 is returned.
  49 .SH DIAGNOSTICS
  50 All error messages are directed to the
  51 .BR TIFFError (3TIFF)
  52 routine.
  53 .SH "SEE ALSO"
  54 .BR TIFFOpen (3TIFF),
  55 .BR TIFFWriteEncodedStrip (3TIFF),
  56 .BR TIFFWriteEncodedTile (3TIFF),
  57 .BR TIFFWriteRawStrip (3TIFF),
  58 .BR TIFFWriteRawTile (3TIFF),
  59 .BR TIFFWriteScanline (3TIFF),
  60 .BR TIFFWriteTile (3TIFF)
  61 .BR libtiff (3TIFF),
  62 .PP
  63 Libtiff library home page:
  64 .BR http://www.remotesensing.org/libtiff/