contrib/libpcap/pcap_setfilter.3pcap

   1 .\" Copyright (c) 1994, 1996, 1997
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .TH PCAP_SETFILTER 3PCAP "25 July 2018"
  21 .SH NAME
  22 pcap_setfilter \- set the filter
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .ft B
  30 int pcap_setfilter(pcap_t *p, struct bpf_program *fp);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 .B pcap_setfilter()
  35 is used to specify a filter program.
  36 .I fp
  37 is a pointer to a
  38 .I bpf_program
  39 struct, usually the result of a call to
  40 .BR \%pcap_compile(3PCAP) .
  41 .SH RETURN VALUE
  42 .B pcap_setfilter()
  43 returns 0 on success and
  44 .B PCAP_ERROR
  45 on failure. If
  46 .B PCAP_ERROR
  47 is returned,
  48 .B pcap_geterr(3PCAP)
  49 or
  50 .B pcap_perror(3PCAP)
  51 may be called with
  52 .I p
  53 as an argument to fetch or display the error text.
  54 .SH SEE ALSO
  55 pcap(3PCAP)