src/tiff/man/TIFFmemory.3tiff

   1 .\" $Id: TIFFmemory.3tiff,v 1.2 2005-11-02 11:07:18 dron Exp $
   2 .\"
   3 .\" Copyright (c) 1995 Sam Leffler
   4 .\" Copyright (c) 1995 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 MEMORY 3TIFF "October 15, 1995" "libtiff"
  27 .SH NAME
  28 _TIFFmalloc, \c
  29 _TIFFrealloc, \c
  30 _TIFFfree, \c
  31 _TIFFmemset, \c
  32 _TIFFmemcpy, \c
  33 _TIFFmemcmp, \c
  34 \- memory management-related functions for use with
  35 .SM TIFF
  36 files
  37 .SH SYNOPSIS
  38 .B "#include <tiffio.h>"
  39 .sp
  40 .BI "tdata_t _TIFFmalloc(tsize_t " size ");"
  41 .br
  42 .BI "tdata_t _TIFFrealloc(tdata_t " buffer ", tsize_t " size ");"
  43 .br
  44 .BI "void _TIFFfree(tdata_t " buffer ");"
  45 .br
  46 .BI "void _TIFFmemset(tdata_t " s ", int " c ", tsize_t " n ");"
  47 .br
  48 .BI "void _TIFFmemcpy(tdata_t " dest ", const tdata_t " src ", tsize_t " n ");"
  49 .br
  50 .BI "int _TIFFmemcmp(const tdata_t " s1 ", const tdata_t "s2 ", tsize_t " n ");"
  51 .SH DESCRIPTION
  52 These routines are provided for writing portable software that uses
  53 .IR libtiff ;
  54 they hide any memory-management related issues, such as dealing with segmented
  55 architectures found on 16-bit machines.
  56 .PP
  57 .I _TIFFmalloc
  58 and
  59 .I _TIFFrealloc
  60 are used to dynamically allocate and reallocate memory used by
  61 .IR libtiff ;
  62 such as memory passed into the I/O routines. Memory allocated through these
  63 interfaces is released back to the system using the
  64 .I _TIFFfree
  65 routine.
  66 .PP
  67 Memory allocated through one of the above interfaces can be set to a known
  68 value using
  69 .IR _TIFFmemset ,
  70 copied to another memory location using
  71 .IR _TIFFmemcpy ,
  72 or compared for equality using
  73 .IR _TIFFmemcmp .
  74 These routines conform to the equivalent
  75 .SM ANSI
  76 C routines:
  77 .IR memset ,
  78 .IR memcpy ,
  79 and
  80 .IR memcmp ,
  81 repsectively.
  82 .SH DIAGNOSTICS
  83 None.
  84 .SH "SEE ALSO"
  85 .BR malloc (3),
  86 .BR memory (3),
  87 .BR libtiff (3TIFF)
  88 .PP
  89 Libtiff library home page:
  90 .BR http://www.remotesensing.org/libtiff/