contrib/libpcap/pcap_lookupdev.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_LOOKUPDEV 3PCAP "3 January 2014"
  21 .SH NAME
  22 pcap_lookupdev \- find the default device on which to capture
  23 .SH SYNOPSIS
  24 .nf
  25 .ft B
  26 #include <pcap/pcap.h>
  27 .ft
  28 .LP
  29 .nf
  30 .ft B
  31 char errbuf[PCAP_ERRBUF_SIZE];
  32 .ft
  33 .LP
  34 .ft B
  35 char *pcap_lookupdev(char *errbuf);
  36 .ft
  37 .fi
  38 .SH DESCRIPTION
  39 .B pcap_lookupdev()
  40 returns a pointer to a string giving the name of a network device
  41 suitable for use with
  42 .B pcap_create()
  43 and
  44 .BR pcap_activate() ,
  45 or with
  46 .BR pcap_open_live() ,
  47 and with
  48 .BR pcap_lookupnet() .
  49 If there is an error,
  50 .B NULL
  51 is returned and
  52 .I errbuf
  53 is filled in with an appropriate error message.
  54 .I errbuf
  55 is assumed to be able to hold at least
  56 .B PCAP_ERRBUF_SIZE
  57 chars.
  58 .SH SEE ALSO
  59 pcap(3PCAP), pcap_create(3PCAP), pcap_activate(3PCAP),
  60 pcap_open_live(3PCAP), pcap_lookupnet(3PCAP)