blob: 260601a97029be6dbc594110727fb7c7f2254627 [file] [log] [blame]
JP Abgrall511eca32014-02-12 13:46:45 -08001.\" 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.\"
Elliott Hughes965a4b52017-05-15 10:37:39 -070020.TH PCAP_IS_SWAPPED 3PCAP "7 April 2014"
JP Abgrall511eca32014-02-12 13:46:45 -080021.SH NAME
22pcap_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
30int pcap_is_swapped(pcap_t *p);
31.ft
32.fi
33.SH DESCRIPTION
Haibo Huangee759ce2021-01-05 21:34:29 -080034.BR pcap_is_swapped ()
35returns true (\fB1\fP) if
JP Abgrall511eca32014-02-12 13:46:45 -080036.I p
37refers to a ``savefile'' that uses a different byte order
38than the current system. For a live capture, it always returns false
Haibo Huangee759ce2021-01-05 21:34:29 -080039(\fB0\fP).
JP Abgrall511eca32014-02-12 13:46:45 -080040.PP
41It must not be called on a pcap descriptor created by
Haibo Huangee759ce2021-01-05 21:34:29 -080042.BR \%pcap_create (3PCAP)
JP Abgrall511eca32014-02-12 13:46:45 -080043that has not yet been activated by
Haibo Huangee759ce2021-01-05 21:34:29 -080044.BR \%pcap_activate (3PCAP).
JP Abgrall511eca32014-02-12 13:46:45 -080045.SH RETURN VALUE
Haibo Huangee759ce2021-01-05 21:34:29 -080046.BR pcap_is_swapped ()
47returns true (\fB1\fP) or false (\fB0\fP) on success and
JP Abgrall511eca32014-02-12 13:46:45 -080048.B PCAP_ERROR_NOT_ACTIVATED
49if called on a capture handle that has been created but not activated.
50.SH SEE ALSO
Haibo Huangee759ce2021-01-05 21:34:29 -080051.BR pcap (3PCAP)