original/man3/swab.3

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