external/bsd/libpcap/dist/pcap_is_swapped.3pcap

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