contrib/libpcap/pcap_datalink_name_to_val.3pcap

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_datalink_name_to_val.3pcap,v 1.1.2.3 2008-04-06 03:21:55 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_NAME_TO_VAL 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_datalink_name_to_val \- get the link-layer header type value
  25 corresponding to a header type name
  26 .SH SYNOPSIS
  27 .nf
  28 .ft B
  29 #include <pcap/pcap.h>
  30 .ft
  31 .LP
  32 .ft B
  33 int pcap_datalink_name_to_val(const char *name);
  34 .ft
  35 .fi
  36 .SH DESCRIPTION
  37 .B pcap_datalink_name_to_val()
  38 translates a data link type name, which is a
  39 .B DLT_
  40 name with the
  41 .B DLT_
  42 removed, to the corresponding data link type value.  The translation
  43 is case-insensitive.
  44 .SH RETURN VALUE
  45 .B pcap_datalink_name_to_val()
  46 returns 0 on success and \-1 on failure.
  47 .SH SEE ALSO
  48 pcap(3PCAP)