Blame pcap_can_set_rfmon.3pcap

Packit 209cc3
.\" Copyright (c) 1994, 1996, 1997
Packit 209cc3
.\"	The Regents of the University of California.  All rights reserved.
Packit 209cc3
.\"
Packit 209cc3
.\" Redistribution and use in source and binary forms, with or without
Packit 209cc3
.\" modification, are permitted provided that: (1) source code distributions
Packit 209cc3
.\" retain the above copyright notice and this paragraph in its entirety, (2)
Packit 209cc3
.\" distributions including binary code include the above copyright notice and
Packit 209cc3
.\" this paragraph in its entirety in the documentation or other materials
Packit 209cc3
.\" provided with the distribution, and (3) all advertising materials mentioning
Packit 209cc3
.\" features or use of this software display the following acknowledgement:
Packit 209cc3
.\" ``This product includes software developed by the University of California,
Packit 209cc3
.\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
Packit 209cc3
.\" the University nor the names of its contributors may be used to endorse
Packit 209cc3
.\" or promote products derived from this software without specific prior
Packit 209cc3
.\" written permission.
Packit 209cc3
.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
Packit 209cc3
.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
Packit 209cc3
.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
Packit 209cc3
.\"
Packit 209cc3
.TH PCAP_CAN_SET_RFMON 3PCAP "31 July 2016"
Packit 209cc3
.SH NAME
Packit 209cc3
pcap_can_set_rfmon \- check whether monitor mode can be set for a
Packit 209cc3
not-yet-activated capture handle
Packit 209cc3
.SH SYNOPSIS
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
#include <pcap/pcap.h>
Packit 209cc3
.LP
Packit 209cc3
.ft B
Packit 209cc3
int pcap_can_set_rfmon(pcap_t *p);
Packit 209cc3
.ft
Packit 209cc3
.fi
Packit 209cc3
.SH DESCRIPTION
Packit 209cc3
.B pcap_can_set_rfmon()
Packit 209cc3
checks whether monitor mode could be set on a capture handle when
Packit 209cc3
the handle is activated.
Packit 209cc3
.SH RETURN VALUE
Packit 209cc3
.B pcap_can_set_rfmon()
Packit 209cc3
returns 0 if monitor mode could not be set,
Packit 209cc3
1 if monitor mode could be set, and a negative value on error.
Packit 209cc3
A negative return value indicates what error condition occurred.
Packit 209cc3
The possible error values are:
Packit 209cc3
.TP
Packit 209cc3
.B PCAP_ERROR_NO_SUCH_DEVICE
Packit 209cc3
The capture source specified when the handle was created doesn't
Packit 209cc3
exist.
Packit 209cc3
.TP
Packit 209cc3
.B PCAP_ERROR_PERM_DENIED
Packit 209cc3
The process doesn't have permission to check whether monitor mode
Packit 209cc3
could be supported.
Packit 209cc3
.TP
Packit 209cc3
.B PCAP_ERROR_ACTIVATED
Packit 209cc3
The capture handle has already been activated.
Packit 209cc3
.TP
Packit 209cc3
.B PCAP_ERROR
Packit 209cc3
Another error occurred.
Packit 209cc3
.B pcap_geterr(3PCAP)
Packit 209cc3
or
Packit 209cc3
.B \%pcap_perror(3PCAP)
Packit 209cc3
may be called with
Packit 209cc3
.I p
Packit 209cc3
as an argument to fetch or display a message describing the error.
Packit 209cc3
.LP
Packit 209cc3
Additional error codes may be added in the future; a program should
Packit 209cc3
check for 0, 1, and negative, return codes, and treat all negative
Packit 209cc3
return codes as errors.
Packit 209cc3
.B pcap_statustostr(3PCAP)
Packit 209cc3
can be called, with a warning or error code as an argument, to fetch a
Packit 209cc3
message describing the warning or error code.
Packit 209cc3
.SH SEE ALSO
Packit 209cc3
pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
Packit 209cc3
pcap_set_rfmon(3PCAP)