Merge branch 'vendor/LIBPCAP'
[dragonfly.git] / contrib / libpcap / pcap_datalink_val_to_name.3pcap
1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_datalink_val_to_name.3pcap,v 1.3 2008-12-24 21:45:25 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_DATALINK_VAL_TO_NAME 3PCAP "22 August 2010"
23 .SH NAME
24 pcap_datalink_val_to_name, pcap_datalink_val_to_description \- get a
25 name or description for a link-layer header type value
26 .SH SYNOPSIS
27 .nf
28 .ft B
29 #include <pcap.h>
30 .ft
31 .LP
32 .ft B
33 const char *pcap_datalink_val_to_name(int dlt);
34 const char *pcap_datalink_val_to_description(int dlt);
35 .ft
36 .fi
37 .SH DESCRIPTION
38 .B pcap_datalink_val_to_name()
39 translates a link-layer header type value to the corresponding
40 link-layer header type name.  NULL is returned on failure.
41 .PP
42 .B pcap_datalink_val_to_description()
43 translates a link-layer header type value to a short description of that
44 link-layer header type.  NULL is returned on failure.