contrib/libpcap/pcap_can_set_rfmon.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_CAN_SET_RFMON 3PCAP "31 July 2016"
  21 .SH NAME
  22 pcap_can_set_rfmon \- check whether monitor mode can be set for a
  23 not-yet-activated capture handle
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap/pcap.h>
  28 .LP
  29 .ft B
  30 int pcap_can_set_rfmon(pcap_t *p);
  31 .ft
  32 .fi
  33 .SH DESCRIPTION
  34 .B pcap_can_set_rfmon()
  35 checks whether monitor mode could be set on a capture handle when
  36 the handle is activated.
  37 .SH RETURN VALUE
  38 .B pcap_can_set_rfmon()
  39 returns 0 if monitor mode could not be set,
  40 1 if monitor mode could be set, and a negative value on error.
  41 A negative return value indicates what error condition occurred.
  42 The possible error values are:
  43 .TP
  44 .B PCAP_ERROR_NO_SUCH_DEVICE
  45 The capture source specified when the handle was created doesn't
  46 exist.
  47 .TP
  48 .B PCAP_ERROR_PERM_DENIED
  49 The process doesn't have permission to check whether monitor mode
  50 could be supported.
  51 .TP
  52 .B PCAP_ERROR_ACTIVATED
  53 The capture handle has already been activated.
  54 .TP
  55 .B PCAP_ERROR
  56 Another error occurred.
  57 .B pcap_geterr(3PCAP)
  58 or
  59 .B \%pcap_perror(3PCAP)
  60 may be called with
  61 .I p
  62 as an argument to fetch or display a message describing the error.
  63 .LP
  64 Additional error codes may be added in the future; a program should
  65 check for 0, 1, and negative, return codes, and treat all negative
  66 return codes as errors.
  67 .B pcap_statustostr(3PCAP)
  68 can be called, with a warning or error code as an argument, to fetch a
  69 message describing the warning or error code.
  70 .SH SEE ALSO
  71 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  72 pcap_set_rfmon(3PCAP)