.\"   Part of publib.
.\"  
.\"   Copyright (c) 1994-2006 Lars Wirzenius.  All rights reserved.
.\"  
.\"   Redistribution and use in source and binary forms, with or without
.\"   modification, are permitted provided that the following conditions
.\"   are met:
.\"  
.\"   1. Redistributions of source code must retain the above copyright
.\"      notice, this list of conditions and the following disclaimer.
.\"  
.\"   2. Redistributions in binary form must reproduce the above
.\"      copyright notice, this list of conditions and the following
.\"      disclaimer in the documentation and/or other materials provided
.\"      with the distribution.
.\"  
.\"   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
.\"   OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\"   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\"   ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
.\"   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\"   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
.\"   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\"   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
.\"   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
.\"   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
.\"   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"  
.\" part of publib
.\" "@(#)publib-strutil:$Id: memswap.3,v 1.1.1.1 1994/02/03 17:25:30 liw Exp $"
.\"
.TH MEMSWAP 3pub "C Programmer's Manual" Publib "C Programmer's Manual"
.SH NAME
memswap \- swap the contents of two memory blocks
.SH SYNOPSIS
.nf
#include <publib.h>
void \fBmemswap\fR(void *\fIblock1\fR, void *\fIblock2\fR, size_t \fIn\fR);
.SH DESCRIPTION
\fImemswap\fR will swap the contents of the two blocks pointed by
its first two arguments.  The last argument gives the size of the
memory blocks.
.SH EXAMPLE
To swap two structs, one might do the following.
.sp 1
.nf
.in +5
struct tm tm1, tm2;

memswap(&tm1, &tm2, sizeof(struct tm));
.in -5
.SH BUGS
Using \fImemswap\fR to swap small portions of memory is inefficient.
It is not worth it to use it to swap variables of any of the basic
types, for instance.  Use inline code for such cases.  However, for
large portions of memory, e.g., arrays, it is convenient.
.PP
\fImemswap\fR can't swap variables whose address can't be taken.  This
excludes variables with the \fBregister\fR specifier and bitfields in
structs.  But then, there is no way to write a function (or macro) that
can handle any kind of arguments.  Life is hard.
.SH "SEE ALSO"
publib(3)
.SH AUTHOR
Lars Wirzenius (lars.wirzenius@helsinki.fi)