Blame man/TIFFmemory.3tiff

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