contrib/libpcap/pcap_offline_filter.3pcap

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_offline_filter.3pcap,v 1.1 2008-05-13 15:19:56 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_OFFLINE_FILTER 3PCAP "13 May 2008"
  23 .SH NAME
  24 pcap_offline_filter \- check whether a filter matches a packet
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .ft B
  32 int pcap_offline_filter(const struct bpf_program *fp,
  33 .ti +8
  34 const struct pcap_pkthdr *h, const u_char *pkt)
  35 .ft
  36 .fi
  37 .SH DESCRIPTION
  38 .B pcap_offline_filter()
  39 checks whether a filter matches a packet.
  40 .I fp
  41 is a pointer to a
  42 .I bpf_program
  43 struct, usually the result of a call to
  44 .BR pcap_compile() .
  45 .I h
  46 points to the
  47 .I pcap_pkthdr
  48 structure for the packet, and
  49 .I pkt
  50 points to the data in the packet.
  51 .SH RETURN VALUE
  52 .B pcap_offline_filter()
  53 returns the return value of the filter program.  This will be zero if
  54 the packet doesn't match the filter and non-zero if the packet matches
  55 the filter.
  56 .SH SEE ALSO
  57 pcap(3PCAP), pcap_compile(3PCAP)