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 "4 May 2022"
  21 .SH NAME
  22 pcap_datalink_val_to_name, pcap_datalink_val_to_description,
  23 pcap_datalink_val_to_description_or_dlt \- get a
  24 name or description for a link-layer header type value
  25 .SH SYNOPSIS
  26 .nf
  27 .ft B
  28 #include <pcap.h>
  29 .ft
  30 .LP
  31 .ft B
  32 const char *pcap_datalink_val_to_name(int dlt);
  33 const char *pcap_datalink_val_to_description(int dlt);
  34 const char *pcap_datalink_val_to_description_or_dlt(int dlt);
  35 .ft
  36 .fi
  37 .SH DESCRIPTION
  38 .BR pcap_datalink_val_to_name ()
  39 translates a link-layer header type value to the corresponding
  40 link-layer header type name, which is the
  41 .B DLT_
  42 name for the link-layer header type value with the
  43 .B DLT_
  44 removed.
  45 .B NULL
  46 is returned if the type value does not correspond to a known
  47 .B DLT_
  48 value.
  49 .PP
  50 .BR pcap_datalink_val_to_description ()
  51 translates a link-layer header type value to a short description of that
  52 link-layer header type.
  53 .B NULL
  54 is returned if the type value does not correspond to a known
  55 .B DLT_
  56 value.
  57 .PP
  58 .BR pcap_datalink_val_to_description_or_dlt ()
  59 translates a link-layer header type value to a short description of that
  60 link-layer header type just like
  61 .BR pcap_datalink_val_to_description ().
  62 If the type value does not correspond to a known
  63 .B DLT_
  64 value, the string "DLT n" is returned, where n is the value of
  65 the dlt argument.
  66 .SH BACKWARD COMPATIBILITY
  67 The
  68 .BR pcap_datalink_val_to_description_or_dlt ()
  69 function first became available in libpcap release 1.9.1.  In previous
  70 releases,
  71 .BR pcap_datalink_val_to_description ()
  72 would have to be called and, if it returned
  73 .BR NULL ,
  74 a default string would have to be constructed.
  75 .SH SEE ALSO
  76 .BR pcap (3PCAP)