JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 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 | .\" |
Haibo Huang | 165065a | 2018-07-23 17:26:52 -0700 | [diff] [blame] | 20 | .TH PCAP_CAN_SET_RFMON 3PCAP "31 July 2016" |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 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 |
Haibo Huang | ee759ce | 2021-01-05 21:34:29 -0800 | [diff] [blame] | 34 | .BR pcap_can_set_rfmon () |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 35 | checks whether monitor mode could be set on a capture handle when |
| 36 | the handle is activated. |
| 37 | .SH RETURN VALUE |
Haibo Huang | ee759ce | 2021-01-05 21:34:29 -0800 | [diff] [blame] | 38 | .BR pcap_can_set_rfmon () |
| 39 | returns |
| 40 | .B 0 |
| 41 | if monitor mode could not be set, |
| 42 | .B 1 |
| 43 | if monitor mode could be set, and a negative value on error. |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 44 | A negative return value indicates what error condition occurred. |
| 45 | The possible error values are: |
| 46 | .TP |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 47 | .B PCAP_ERROR_NO_SUCH_DEVICE |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 48 | The capture source specified when the handle was created doesn't |
| 49 | exist. |
| 50 | .TP |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 51 | .B PCAP_ERROR_PERM_DENIED |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 52 | The process doesn't have permission to check whether monitor mode |
| 53 | could be supported. |
| 54 | .TP |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 55 | .B PCAP_ERROR_ACTIVATED |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 56 | The capture handle has already been activated. |
| 57 | .TP |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 58 | .B PCAP_ERROR |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 59 | Another error occurred. |
Haibo Huang | ee759ce | 2021-01-05 21:34:29 -0800 | [diff] [blame] | 60 | .BR pcap_geterr (3PCAP) |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 61 | or |
Haibo Huang | ee759ce | 2021-01-05 21:34:29 -0800 | [diff] [blame] | 62 | .BR \%pcap_perror (3PCAP) |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 63 | may be called with |
| 64 | .I p |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 65 | as an argument to fetch or display a message describing the error. |
| 66 | .LP |
| 67 | Additional error codes may be added in the future; a program should |
Haibo Huang | ee759ce | 2021-01-05 21:34:29 -0800 | [diff] [blame] | 68 | check for |
| 69 | .BR 0 , |
| 70 | .BR 1 , |
| 71 | and negative, return codes, and treat all negative |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 72 | return codes as errors. |
Haibo Huang | ee759ce | 2021-01-05 21:34:29 -0800 | [diff] [blame] | 73 | .BR pcap_statustostr (3PCAP) |
Elliott Hughes | 965a4b5 | 2017-05-15 10:37:39 -0700 | [diff] [blame] | 74 | can be called, with a warning or error code as an argument, to fetch a |
| 75 | message describing the warning or error code. |
JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 76 | .SH SEE ALSO |
Haibo Huang | ee759ce | 2021-01-05 21:34:29 -0800 | [diff] [blame] | 77 | .BR pcap (3PCAP), |
| 78 | .BR pcap_create (3PCAP), |
| 79 | .BR pcap_activate (3PCAP), |
| 80 | .BR pcap_set_rfmon (3PCAP) |