Initialize the module for tcpdump

[platform/upstream/libpcap.git] / pcap_is_swapped.3pcap

diff --git a/pcap_is_swapped.3pcap b/pcap_is_swapped.3pcap
index 4d26b3b..a120616 100644 (file)
--- a/pcap_is_swapped.3pcap
+++ b/pcap_is_swapped.3pcap
@@ -1,5 +1,3 @@
-.\" @(#) $Header: /tcpdump/master/libpcap/pcap_is_swapped.3pcap,v 1.3 2008-04-06 02:53:22 guy Exp $
-.\"
 .\" Copyright (c) 1994, 1996, 1997
 .\"    The Regents of the University of California.  All rights reserved.
 .\"
@@ -19,7 +17,7 @@
 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 .\"
-.TH PCAP_IS_SWAPPED 3PCAP "5 April 2008"
+.TH PCAP_IS_SWAPPED 3PCAP "17 September 2013"
 .SH NAME
 pcap_is_swapped \- find out whether a savefile has the native byte order
 .SH SYNOPSIS
@@ -34,9 +32,20 @@ int pcap_is_swapped(pcap_t *p);
 .fi
 .SH DESCRIPTION
 .B pcap_is_swapped()
-returns true if
+returns true (1) if
 .I p
 refers to a ``savefile'' that uses a different byte order
-than the current system.  For a live capture, it always returns false.
+than the current system.  For a live capture, it always returns false
+(0).
+.PP
+It must not be called on a pcap descriptor created by
+.B pcap_create()
+that has not yet been activated by
+.BR pcap_activate() .
+.SH RETURN VALUE
+.B pcap_datalink()
+returns true (1) or false (0) on success and
+.B PCAP_ERROR_NOT_ACTIVATED
+if called on a capture handle that has been created but not activated.
 .SH SEE ALSO
 pcap(3PCAP)