contrib/libpcap/pcap_can_set_rfmon.3pcap

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_can_set_rfmon.3pcap,v 1.1.2.1 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_CAN_SET_RFMON 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_can_set_rfmon \- check whether monitor mode can be set for a
  25 not-yet-activated capture handle
  26 .SH SYNOPSIS
  27 .nf
  28 .ft B
  29 #include <pcap/pcap.h>
  30 .LP
  31 .ft B
  32 int pcap_can_set_rfmon(pcap_t *p);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_can_set_rfmon()
  37 checks whether monitor mode could be set on a capture handle when
  38 the handle is activated.
  39 .SH RETURN VALUE
  40 .B pcap_set_rfmon()
  41 returns 0 if monitor mode could not be set,
  42 1 if monitor mode could be set,
  43 .B PCAP_ERROR_NO_SUCH_DEVICE
  44 if the device specified when the handle was created doesn't exist,
  45 .B PCAP_ERROR_ACTIVATED
  46 if called on a capture handle that has been activated, or
  47 .B PCAP_ERROR
  48 if an error occurred.
  49 If
  50 .B PCAP_ERROR
  51 is returned,
  52 .B pcap_geterr()
  53 or
  54 .B pcap_perror()
  55 may be called with
  56 .I p
  57 as an argument to fetch or display the error text.
  58 .SH SEE ALSO
  59 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  60 pcap_set_rfmon(3PCAP)