Blame man/TIFFmemory.3tiff

Packit 994f1a
.\" $Id: TIFFmemory.3tiff,v 1.2 2005/11/02 11:07:18 dron Exp $
Packit 994f1a
.\"
Packit 994f1a
.\" Copyright (c) 1995 Sam Leffler
Packit 994f1a
.\" Copyright (c) 1995 Silicon Graphics, Inc.
Packit 994f1a
.\"
Packit 994f1a
.\" Permission to use, copy, modify, distribute, and sell this software and 
Packit 994f1a
.\" its documentation for any purpose is hereby granted without fee, provided
Packit 994f1a
.\" that (i) the above copyright notices and this permission notice appear in
Packit 994f1a
.\" all copies of the software and related documentation, and (ii) the names of
Packit 994f1a
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
Packit 994f1a
.\" publicity relating to the software without the specific, prior written
Packit 994f1a
.\" permission of Sam Leffler and Silicon Graphics.
Packit 994f1a
.\" 
Packit 994f1a
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
Packit 994f1a
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
Packit 994f1a
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
Packit 994f1a
.\" 
Packit 994f1a
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
Packit 994f1a
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
Packit 994f1a
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
Packit 994f1a
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
Packit 994f1a
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
Packit 994f1a
.\" OF THIS SOFTWARE.
Packit 994f1a
.\"
Packit 994f1a
.if n .po 0
Packit 994f1a
.TH MEMORY 3TIFF "October 15, 1995" "libtiff"
Packit 994f1a
.SH NAME
Packit 994f1a
_TIFFmalloc, \c
Packit 994f1a
_TIFFrealloc, \c
Packit 994f1a
_TIFFfree, \c
Packit 994f1a
_TIFFmemset, \c
Packit 994f1a
_TIFFmemcpy, \c
Packit 994f1a
_TIFFmemcmp, \c
Packit 994f1a
\- memory management-related functions for use with
Packit 994f1a
.SM TIFF
Packit 994f1a
files
Packit 994f1a
.SH SYNOPSIS
Packit 994f1a
.B "#include <tiffio.h>"
Packit 994f1a
.sp
Packit 994f1a
.BI "tdata_t _TIFFmalloc(tsize_t " size ");"
Packit 994f1a
.br
Packit 994f1a
.BI "tdata_t _TIFFrealloc(tdata_t " buffer ", tsize_t " size ");"
Packit 994f1a
.br
Packit 994f1a
.BI "void _TIFFfree(tdata_t " buffer ");"
Packit 994f1a
.br
Packit 994f1a
.BI "void _TIFFmemset(tdata_t " s ", int " c ", tsize_t " n ");"
Packit 994f1a
.br
Packit 994f1a
.BI "void _TIFFmemcpy(tdata_t " dest ", const tdata_t " src ", tsize_t " n ");"
Packit 994f1a
.br
Packit 994f1a
.BI "int _TIFFmemcmp(const tdata_t " s1 ", const tdata_t "s2 ", tsize_t " n ");"
Packit 994f1a
.SH DESCRIPTION
Packit 994f1a
These routines are provided for writing portable software that uses 
Packit 994f1a
.IR libtiff ;
Packit 994f1a
they hide any memory-management related issues, such as dealing with segmented
Packit 994f1a
architectures found on 16-bit machines.
Packit 994f1a
.PP
Packit 994f1a
.I _TIFFmalloc
Packit 994f1a
and
Packit 994f1a
.I _TIFFrealloc
Packit 994f1a
are used to dynamically allocate and reallocate memory used by 
Packit 994f1a
.IR libtiff ;
Packit 994f1a
such as memory passed into the I/O routines. Memory allocated through these
Packit 994f1a
interfaces is released back to the system using the
Packit 994f1a
.I _TIFFfree
Packit 994f1a
routine.
Packit 994f1a
.PP
Packit 994f1a
Memory allocated through one of the above interfaces can be set to a known
Packit 994f1a
value using
Packit 994f1a
.IR _TIFFmemset ,
Packit 994f1a
copied to another memory location using
Packit 994f1a
.IR _TIFFmemcpy ,
Packit 994f1a
or compared for equality using 
Packit 994f1a
.IR _TIFFmemcmp .
Packit 994f1a
These routines conform to the equivalent
Packit 994f1a
.SM ANSI
Packit 994f1a
C routines: 
Packit 994f1a
.IR memset ,
Packit 994f1a
.IR memcpy ,
Packit 994f1a
and
Packit 994f1a
.IR memcmp ,
Packit 994f1a
repsectively.
Packit 994f1a
.SH DIAGNOSTICS
Packit 994f1a
None.
Packit 994f1a
.SH "SEE ALSO"
Packit 994f1a
.BR malloc (3),
Packit 994f1a
.BR memory (3),
Packit 994f1a
.BR libtiff (3TIFF)
Packit 994f1a
.PP
Packit 994f1a
Libtiff library home page:
Packit 994f1a
.BR http://www.remotesensing.org/libtiff/