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  2021-03-22 "" "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 .PP
  39 .BI "void swab(const void *restrict " from ", void *restrict " to \
  40 ", ssize_t " n );
  41 .fi
  42 .SH DESCRIPTION
  43 The
  44 .BR swab ()
  45 function copies
  46 .I n
  47 bytes from the array pointed
  48 to by
  49 .I from
  50 to the array pointed to by
  51 .IR to ,
  52 exchanging
  53 adjacent even and odd bytes.
  54 This function is used to exchange data
  55 between machines that have different low/high byte ordering.
  56 .PP
  57 This function does nothing when
  58 .I n
  59 is negative.
  60 When
  61 .I n
  62 is positive and odd, it handles
  63 .I n\-1
  64 bytes
  65 as above, and does something unspecified with the last byte.
  66 (In other words,
  67 .I n
  68 should be even.)
  69 .SH RETURN VALUE
  70 The
  71 .BR swab ()
  72 function returns no value.
  73 .SH ATTRIBUTES
  74 For an explanation of the terms used in this section, see
  75 .BR attributes (7).
  76 .ad l
  77 .nh
  78 .TS
  79 allbox;
  80 lbx lb lb
  81 l l l.
  82 Interface       Attribute       Value
  83 T{
  84 .BR swab ()
  85 T}      Thread safety   MT-Safe
  86 .TE
  87 .hy
  88 .ad
  89 .sp 1
  90 .SH CONFORMING TO
  91 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
  92 .SH SEE ALSO
  93 .BR bstring (3)