blob: f8e40977d1e7df5e9747058d72146244b907270a [file] [log] [blame]
JP Abgrall511eca32014-02-12 13:46:45 -08001.\" @(#) $Header: /tcpdump/master/libpcap/pcap_snapshot.3pcap,v 1.3 2008-04-06 02:53:22 guy 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_SNAPSHOT 3PCAP "5 April 2008"
23.SH NAME
24pcap_snapshot \- get the snapshot length
25.SH SYNOPSIS
26.nf
27.ft B
28#include <pcap/pcap.h>
29.ft
30.LP
31.ft B
32int pcap_snapshot(pcap_t *p);
33.ft
34.fi
35.SH DESCRIPTION
36.B pcap_snapshot()
37returns the snapshot length specified when
38.B pcap_set_snapshot()
39or
40.B pcap_open_live()
41was called, for a live capture, or the snapshot length from the capture
42file, for a ``savefile''.
43.PP
44It must not be called on a pcap descriptor created by
45.B pcap_create()
46that has not yet been activated by
47.BR pcap_activate() .
48.SH RETURN VALUE
49.B pcap_snapshot()
50returns the snapshot length on success and
51.B PCAP_ERROR_NOT_ACTIVATED
52if called on a capture handle that has been created but not activated.
53.SH SEE ALSO
54pcap(3PCAP)