| .\" @(#) $Header: /tcpdump/master/libpcap/pcap_activate.3pcap,v 1.5 2008-07-01 08:02:33 guy Exp $ |
| .\" |
| .\" Copyright (c) 1994, 1996, 1997 |
| .\" The Regents of the University of California. All rights reserved. |
| .\" |
| .\" Redistribution and use in source and binary forms, with or without |
| .\" modification, are permitted provided that: (1) source code distributions |
| .\" retain the above copyright notice and this paragraph in its entirety, (2) |
| .\" distributions including binary code include the above copyright notice and |
| .\" this paragraph in its entirety in the documentation or other materials |
| .\" provided with the distribution, and (3) all advertising materials mentioning |
| .\" features or use of this software display the following acknowledgement: |
| .\" ``This product includes software developed by the University of California, |
| .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of |
| .\" the University nor the names of its contributors may be used to endorse |
| .\" or promote products derived from this software without specific prior |
| .\" written permission. |
| .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED |
| .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF |
| .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. |
| .\" |
| .TH PCAP_ACTIVATE 3PCAP "5 April 2008" |
| .SH NAME |
| pcap_activate \- activate a capture handle |
| .SH SYNOPSIS |
| .nf |
| .ft B |
| #include <pcap/pcap.h> |
| .ft |
| .LP |
| .ft B |
| int pcap_activate(pcap_t *p); |
| .ft |
| .fi |
| .SH DESCRIPTION |
| .B pcap_activate() |
| is used to activate a packet capture handle to look |
| at packets on the network, with the options that were set on the handle |
| being in effect. |
| .SH RETURN VALUE |
| .B pcap_activate() |
| returns 0 on success without warnings, |
| .B PCAP_WARNING_PROMISC_NOTSUP |
| on success on a device that doesn't support promiscuous mode if |
| promiscuous mode was requested, |
| .B PCAP_WARNING_TSTAMP_TYPE_NOTSUP |
| on success if the time stamp type specified in a previous |
| .B pcap_set_tstamp_type() |
| call isn't supported by the capture source (the time stamp type is |
| left as the default), |
| .B PCAP_WARNING |
| on success with any other warning, |
| .B PCAP_ERROR_ACTIVATED |
| if the handle has already been activated, |
| .B PCAP_ERROR_NO_SUCH_DEVICE |
| if the capture source specified when the handle was created doesn't |
| exist, |
| .B PCAP_ERROR_PERM_DENIED |
| if the process doesn't have permission to open the capture source, |
| .B PCAP_ERROR_PROMISC_PERM_DENIED |
| if the process has permission to open the capture source but doesn't |
| have permission to put it into promiscuous mode, |
| .B PCAP_ERROR_RFMON_NOTSUP |
| if monitor mode was specified but the capture source doesn't support |
| monitor mode, |
| .B PCAP_ERROR_IFACE_NOT_UP |
| if the capture source is not up, and |
| .B PCAP_ERROR |
| if another error occurred. |
| If |
| .B PCAP_WARNING |
| or |
| .B PCAP_ERROR |
| is returned, |
| .B pcap_geterr() |
| or |
| .B pcap_perror() |
| may be called with |
| .I p |
| as an argument to fetch or display a message describing the warning or |
| error. |
| If |
| .BR PCAP_WARNING_PROMISC_NOTSUP , |
| .BR PCAP_ERROR_NO_SUCH_DEVICE , |
| or |
| .B PCAP_ERROR_PERM_DENIED |
| is returned, |
| .B pcap_geterr() |
| or |
| .B pcap_perror() |
| may be called with |
| .I p |
| as an argument to fetch or display an message giving additional details |
| about the problem that might be useful for debugging the problem if it's |
| unexpected. |
| .SH SEE ALSO |
| pcap(3PCAP) |
