contrib/libpcap/pcap_datalink_name_to_val.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_NAME_TO_VAL 3PCAP "25 July 2018"
  21 .SH NAME
  22 pcap_datalink_name_to_val \- get the link-layer header type value
  23 corresponding to a header type name
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap/pcap.h>
  28 .ft
  29 .LP
  30 .ft B
  31 int pcap_datalink_name_to_val(const char *name);
  32 .ft
  33 .fi
  34 .SH DESCRIPTION
  35 .B pcap_datalink_name_to_val()
  36 translates a link-layer header type name, which is a
  37 .B DLT_
  38 name with the
  39 .B DLT_
  40 removed, to the corresponding link-layer header type value.  The
  41 translation is case-insensitive.
  42 .SH RETURN VALUE
  43 .B pcap_datalink_name_to_val()
  44 returns the type value on success and
  45 .B PCAP_ERROR
  46 if the name is not a known
  47 type name..
  48 .SH SEE ALSO
  49 pcap(3PCAP)