man3/swab.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" References consulted:
  24 .\"     Linux libc source code
  25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  26 .\"     386BSD man pages
  27 .\" Modified Sat Jul 24 17:52:15 1993 by Rik Faith (faith@cs.unc.edu)
  28 .\" Modified 2001-12-15, aeb
  29 .TH SWAB 3  2001-12-15 "" "Linux Programmer's Manual"
  30 .SH NAME
  31 swab \- swap adjacent bytes
  32 .SH SYNOPSIS
  33 .nf
  34 .B #define _XOPEN_SOURCE
  35 .B #include <unistd.h>
  36 .sp
  37 .BI "void swab(const void *" from ", void *" to ", ssize_t " n );
  38 .fi
  39 .SH DESCRIPTION
  40 The
  41 .BR swab ()
  42 function copies \fIn\fP bytes from the array pointed
  43 to by \fIfrom\fP to the array pointed to by \fIto\fP, exchanging
  44 adjacent even and odd bytes.
  45 This function is used to exchange data
  46 between machines that have different low/high byte ordering.
  47 .LP
  48 This function does nothing when \fIn\fP is negative.
  49 When \fIn\fP is positive and odd, it handles \fIn\-1\fP bytes
  50 as above, and does something unspecified with the last byte.
  51 (In other words, \fIn\fP should be even.)
  52 .SH "RETURN VALUE"
  53 The
  54 .BR swab ()
  55 function returns no value.
  56 .SH "CONFORMING TO"
  57 SVr4, 4.3BSD, POSIX.1-2001
  58 .SH "SEE ALSO"
  59 .BR bstring (3),
  60 .BR feature_test_macros (7)