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

   1 .\"     $NetBSD: pcap_snapshot.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_SNAPSHOT 3PCAP "17 September 2013"
  23 .SH NAME
  24 pcap_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
  32 int pcap_snapshot(pcap_t *p);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_snapshot()
  37 returns the snapshot length specified when
  38 .B pcap_set_snapshot()
  39 or
  40 .B pcap_open_live()
  41 was called, for a live capture, or the snapshot length from the capture
  42 file, for a ``savefile''.
  43 .PP
  44 It must not be called on a pcap descriptor created by
  45 .B pcap_create()
  46 that has not yet been activated by
  47 .BR pcap_activate() .
  48 .SH RETURN VALUE
  49 .B pcap_snapshot()
  50 returns the snapshot length on success and
  51 .B PCAP_ERROR_NOT_ACTIVATED
  52 if called on a capture handle that has been created but not activated.
  53 .SH SEE ALSO
  54 pcap(3PCAP)