contrib/libpcap/pcap_is_swapped.3pcap

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_IS_SWAPPED 3PCAP "7 April 2014"
  21 .SH NAME
  22 pcap_is_swapped \- find out whether a savefile has the native byte order
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 int pcap_is_swapped(pcap_t *p);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 .BR pcap_is_swapped ()
  35 returns true (\fB1\fP) if
  36 .I p
  37 refers to a ``savefile'' that uses a different byte order
  38 than the current system.  For a live capture, it always returns false
  39 (\fB0\fP).
  40 .PP
  41 It must not be called on a pcap descriptor created by
  42 .BR \%pcap_create (3PCAP)
  43 that has not yet been activated by
  44 .BR \%pcap_activate (3PCAP).
  45 .SH RETURN VALUE
  46 .BR pcap_is_swapped ()
  47 returns true (\fB1\fP) or false (\fB0\fP) on success and
  48 .B PCAP_ERROR_NOT_ACTIVATED
  49 if called on a capture handle that has been created but not activated.
  50 .SH SEE ALSO
  51 .BR pcap (3PCAP)