contrib/libpcap/pcap_file.3pcap

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_file.3pcap,v 1.1.2.3 2008-04-06 03:21:55 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_FILE 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_file \- get the standard I/O stream for a savefile being read
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .ft B
  32 FILE *pcap_file(pcap_t *p);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_file()
  37 returns the standard I/O stream of the ``savefile,'' if a ``savefile''
  38 was opened with
  39 .BR pcap_open_offline() ,
  40 or NULL, if a network device was opened with
  41 .B pcap_create()
  42 and
  43 .BR pcap_activate() ,
  44 or with
  45 .BR pcap_open_live() .
  46 .PP
  47 Note that the Packet Capture library is usually built with large file
  48 support, so the standard I/O stream of the ``savefile'' might refer to
  49 a file larger than 2 gigabytes; applications that use
  50 .B pcap_file()
  51 should, if possible, use calls that support large files on the return
  52 value of
  53 .B pcap_file()
  54 or the value returned by
  55 .B fileno()
  56 when passed the return value of
  57 .BR pcap_file() .
  58 .SH SEE ALSO
  59 pcap(3PCAP), pcap_open_offline(3PCAP)