| JP Abgrall | 511eca3 | 2014-02-12 13:46:45 -0800 | [diff] [blame] | 1 | .\" @(#) $Header: /tcpdump/master/libpcap/pcap_activate.3pcap,v 1.5 2008-07-01 08:02:33 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_ACTIVATE 3PCAP "5 April 2008" |
| 23 | .SH NAME |
| 24 | pcap_activate \- activate a capture handle |
| 25 | .SH SYNOPSIS |
| 26 | .nf |
| 27 | .ft B |
| 28 | #include <pcap/pcap.h> |
| 29 | .ft |
| 30 | .LP |
| 31 | .ft B |
| 32 | int pcap_activate(pcap_t *p); |
| 33 | .ft |
| 34 | .fi |
| 35 | .SH DESCRIPTION |
| 36 | .B pcap_activate() |
| 37 | is used to activate a packet capture handle to look |
| 38 | at packets on the network, with the options that were set on the handle |
| 39 | being in effect. |
| 40 | .SH RETURN VALUE |
| 41 | .B pcap_activate() |
| 42 | returns 0 on success without warnings, |
| 43 | .B PCAP_WARNING_PROMISC_NOTSUP |
| 44 | on success on a device that doesn't support promiscuous mode if |
| 45 | promiscuous mode was requested, |
| 46 | .B PCAP_WARNING_TSTAMP_TYPE_NOTSUP |
| 47 | on success if the time stamp type specified in a previous |
| 48 | .B pcap_set_tstamp_type() |
| 49 | call isn't supported by the capture source (the time stamp type is |
| 50 | left as the default), |
| 51 | .B PCAP_WARNING |
| 52 | on success with any other warning, |
| 53 | .B PCAP_ERROR_ACTIVATED |
| 54 | if the handle has already been activated, |
| 55 | .B PCAP_ERROR_NO_SUCH_DEVICE |
| 56 | if the capture source specified when the handle was created doesn't |
| 57 | exist, |
| 58 | .B PCAP_ERROR_PERM_DENIED |
| 59 | if the process doesn't have permission to open the capture source, |
| 60 | .B PCAP_ERROR_PROMISC_PERM_DENIED |
| 61 | if the process has permission to open the capture source but doesn't |
| 62 | have permission to put it into promiscuous mode, |
| 63 | .B PCAP_ERROR_RFMON_NOTSUP |
| 64 | if monitor mode was specified but the capture source doesn't support |
| 65 | monitor mode, |
| 66 | .B PCAP_ERROR_IFACE_NOT_UP |
| 67 | if the capture source is not up, and |
| 68 | .B PCAP_ERROR |
| 69 | if another error occurred. |
| 70 | If |
| 71 | .B PCAP_WARNING |
| 72 | or |
| 73 | .B PCAP_ERROR |
| 74 | is returned, |
| 75 | .B pcap_geterr() |
| 76 | or |
| 77 | .B pcap_perror() |
| 78 | may be called with |
| 79 | .I p |
| 80 | as an argument to fetch or display a message describing the warning or |
| 81 | error. |
| 82 | If |
| 83 | .BR PCAP_WARNING_PROMISC_NOTSUP , |
| 84 | .BR PCAP_ERROR_NO_SUCH_DEVICE , |
| 85 | or |
| 86 | .B PCAP_ERROR_PERM_DENIED |
| 87 | is returned, |
| 88 | .B pcap_geterr() |
| 89 | or |
| 90 | .B pcap_perror() |
| 91 | may be called with |
| 92 | .I p |
| 93 | as an argument to fetch or display an message giving additional details |
| 94 | about the problem that might be useful for debugging the problem if it's |
| 95 | unexpected. |
| 96 | .SH SEE ALSO |
| 97 | pcap(3PCAP) |