src/tiff/man/TIFFmemory.3tiff

   1 .\"
   2 .\" Copyright (c) 1995 Sam Leffler
   3 .\" Copyright (c) 1995 Silicon Graphics, Inc.
   4 .\"
   5 .\" Permission to use, copy, modify, distribute, and sell this software and
   6 .\" its documentation for any purpose is hereby granted without fee, provided
   7 .\" that (i) the above copyright notices and this permission notice appear in
   8 .\" all copies of the software and related documentation, and (ii) the names of
   9 .\" Sam Leffler and Silicon Graphics may not be used in any advertising or
  10 .\" publicity relating to the software without the specific, prior written
  11 .\" permission of Sam Leffler and Silicon Graphics.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
  14 .\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  15 .\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  16 .\"
  17 .\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  18 .\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  19 .\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  20 .\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  21 .\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  22 .\" OF THIS SOFTWARE.
  23 .\"
  24 .if n .po 0
  25 .TH MEMORY 3TIFF "October 15, 1995" "libtiff"
  26 .SH NAME
  27 _TIFFmalloc, \c
  28 _TIFFrealloc, \c
  29 _TIFFfree, \c
  30 _TIFFmemset, \c
  31 _TIFFmemcpy, \c
  32 _TIFFmemcmp, \c
  33 \- memory management-related functions for use with
  34 .SM TIFF
  35 files
  36 .SH SYNOPSIS
  37 .B "#include <tiffio.h>"
  38 .sp
  39 .BI "tdata_t _TIFFmalloc(tsize_t " size ");"
  40 .br
  41 .BI "tdata_t _TIFFrealloc(tdata_t " buffer ", tsize_t " size ");"
  42 .br
  43 .BI "void _TIFFfree(tdata_t " buffer ");"
  44 .br
  45 .BI "void _TIFFmemset(tdata_t " s ", int " c ", tsize_t " n ");"
  46 .br
  47 .BI "void _TIFFmemcpy(tdata_t " dest ", const tdata_t " src ", tsize_t " n ");"
  48 .br
  49 .BI "int _TIFFmemcmp(const tdata_t " s1 ", const tdata_t "s2 ", tsize_t " n ");"
  50 .SH DESCRIPTION
  51 These routines are provided for writing portable software that uses
  52 .IR libtiff ;
  53 they hide any memory-management related issues, such as dealing with segmented
  54 architectures found on 16-bit machines.
  55 .PP
  56 .I _TIFFmalloc
  57 and
  58 .I _TIFFrealloc
  59 are used to dynamically allocate and reallocate memory used by
  60 .IR libtiff ;
  61 such as memory passed into the I/O routines. Memory allocated through these
  62 interfaces is released back to the system using the
  63 .I _TIFFfree
  64 routine.
  65 .PP
  66 Memory allocated through one of the above interfaces can be set to a known
  67 value using
  68 .IR _TIFFmemset ,
  69 copied to another memory location using
  70 .IR _TIFFmemcpy ,
  71 or compared for equality using
  72 .IR _TIFFmemcmp .
  73 These routines conform to the equivalent
  74 .SM ANSI
  75 C routines:
  76 .IR memset ,
  77 .IR memcpy ,
  78 and
  79 .IR memcmp ,
  80 repsectively.
  81 .SH DIAGNOSTICS
  82 None.
  83 .SH "SEE ALSO"
  84 .BR malloc (3),
  85 .BR memory (3),
  86 .BR libtiff (3TIFF)
  87 .PP
  88 Libtiff library home page:
  89 .BR http://www.remotesensing.org/libtiff/