Blame pcap_lookupdev.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_LOOKUPDEV 3PCAP "8 September 2017"
Packit 209cc3
.SH NAME
Packit 209cc3
pcap_lookupdev \- find the default device on which to capture
Packit 209cc3
.SH SYNOPSIS
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
#include <pcap/pcap.h>
Packit 209cc3
.ft
Packit 209cc3
.LP
Packit 209cc3
.nf
Packit 209cc3
.ft B
Packit 209cc3
char errbuf[PCAP_ERRBUF_SIZE];
Packit 209cc3
.ft
Packit 209cc3
.LP
Packit 209cc3
.ft B
Packit 209cc3
[DEPRECATED] char *pcap_lookupdev(char *errbuf);
Packit 209cc3
.ft
Packit 209cc3
.fi
Packit 209cc3
.SH DESCRIPTION
Packit 209cc3
.B This interface is obsoleted by
Packit 209cc3
.BR pcap_findalldevs (3PCAP).
Packit 209cc3
To find a default device on which to capture, call
Packit 209cc3
.B pcap_findalldevs()
Packit 209cc3
and, if the list it returns is not empty, use the first device in the
Packit 209cc3
list.  (If the list is empty, there are no devices on which capture is
Packit 209cc3
possible.)
Packit 209cc3
.LP
Packit 209cc3
.B pcap_lookupdev()
Packit 209cc3
returns a pointer to a string giving the name of a network device
Packit 209cc3
suitable for use with
Packit 209cc3
.B pcap_create(3PCAP)
Packit 209cc3
and
Packit 209cc3
.BR \%pcap_activate(3PCAP) ,
Packit 209cc3
or with
Packit 209cc3
.BR pcap_open_live(3PCAP) ,
Packit 209cc3
and with
Packit 209cc3
.BR pcap_lookupnet(3PCAP) .
Packit 209cc3
If there is an error,
Packit 209cc3
.B NULL
Packit 209cc3
is returned and
Packit 209cc3
.I errbuf
Packit 209cc3
is filled in with an appropriate error message.
Packit 209cc3
.I errbuf
Packit 209cc3
is assumed to be able to hold at least
Packit 209cc3
.B PCAP_ERRBUF_SIZE
Packit 209cc3
chars.
Packit 209cc3
.SH SEE ALSO
Packit 209cc3
pcap(3PCAP)
Packit 209cc3
.SH BUGS
Packit 209cc3
The pointer returned by
Packit 209cc3
.B pcap_lookupdev()
Packit 209cc3
points to a static buffer; subsequent calls to
Packit 209cc3
.B pcap_lookupdev()
Packit 209cc3
in the same thread, or calls to
Packit 209cc3
.B pcap_lookupdev()
Packit 209cc3
in another thread, may overwrite that buffer.
Packit 209cc3
.LP
Packit 209cc3
In WinPcap, this function may return a UTF-16 string rather than an
Packit 209cc3
ASCII or UTF-8 string.
Packit 209cc3