contrib/libpcap/pcap_list_datalinks.3pcap.in

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_list_datalinks.3pcap.in,v 1.1.2.2 2008-10-21 07:44:57 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_LIST_DATALINKS 3PCAP "5 April 2008"
  23 .SH NAME
  24 pcap_list_datalinks \- get a list of link-layer header types supported
  25 by a capture device
  26 .SH SYNOPSIS
  27 .nf
  28 .ft B
  29 #include <pcap/pcap.h>
  30 .ft
  31 .LP
  32 .ft B
  33 int pcap_list_datalinks(pcap_t *p, int **dlt_buf);
  34 .ft
  35 .fi
  36 .SH DESCRIPTION
  37 .B pcap_list_datalinks()
  38 is used to get a list of the supported data link types of the interface
  39 associated with the pcap descriptor.
  40 .B pcap_list_datalinks()
  41 allocates an array to hold the list and sets
  42 .IR *dlt_buf .
  43 The caller is responsible for freeing the array with
  44 .BR pcap_free_datalinks (3PCAP).
  45 .SH RETURN VALUE
  46 .B pcap_list_datalinks()
  47 returns the number of data link types in the array on success and \-1
  48 on failure.
  49 If \-1 is returned,
  50 .B pcap_geterr()
  51 or
  52 .B pcap_perror()
  53 may be called with
  54 .I p
  55 as an argument to fetch or display the error text.
  56 .SH SEE ALSO
  57 pcap(3PCAP), pcap_geterr(3PCAP), pcap_free_datalinks(3PCAP),
  58 pcap-linktype(@MAN_MISC_INFO@)