contrib/libpcap/pcap_setfilter.3pcap

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_setfilter.3pcap,v 1.1.2.4 2008-05-13 15:20:44 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_SETFILTER 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_setfilter \- set the filter
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap/pcap.h>
  29 .ft
  30 .LP
  31 .ft B
  32 int pcap_setfilter(pcap_t *p, struct bpf_program *fp);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_setfilter()
  37 is used to specify a filter program.
  38 .I fp
  39 is a pointer to a
  40 .I bpf_program
  41 struct, usually the result of a call to
  42 .BR pcap_compile() .
  43 .SH RETURN VALUE
  44 .B pcap_setfilter()
  45 returns 0 on success and \-1 on failure.
  46 If \-1 is returned,
  47 .B pcap_geterr()
  48 or
  49 .B pcap_perror()
  50 may be called with
  51 .I p
  52 as an argument to fetch or display the error text.
  53 .SH SEE ALSO
  54 pcap(3PCAP), pcap_compile(3PCAP), pcap_geterr(3PCAP)