contrib/libpcap/pcap_datalink_val_to_name.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_DATALINK_VAL_TO_NAME 3PCAP "3 January 2014"
  21 .SH NAME
  22 pcap_datalink_val_to_name, pcap_datalink_val_to_description \- get a
  23 name or description for a link-layer header type value
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap.h>
  28 .ft
  29 .LP
  30 .ft B
  31 const char *pcap_datalink_val_to_name(int dlt);
  32 const char *pcap_datalink_val_to_description(int dlt);
  33 .ft
  34 .fi
  35 .SH DESCRIPTION
  36 .B pcap_datalink_val_to_name()
  37 translates a link-layer header type value to the corresponding
  38 link-layer header type name, which is the
  39 .B DLT_
  40 name for the link-layer header type value with the
  41 .B DLT_
  42 removed.
  43 .B NULL
  44 is returned if the type value does not correspond to a known
  45 .B DLT_
  46 value.
  47 .PP
  48 .B pcap_datalink_val_to_description()
  49 translates a link-layer header type value to a short description of that
  50 link-layer header type.
  51 .B NULL
  52 is returned if the type value does not correspond to a known
  53 .B DLT_
  54 value.