contrib/libpcap/pcap_list_datalinks.3pcap.in

   1 .\" @(#) $Header: /tcpdump/master/libpcap/pcap_list_datalinks.3pcap.in,v 1.1 2008-10-21 07:33:02 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 "22 August 2010"
  23 .SH NAME
  24 pcap_list_datalinks, pcap_free_datalinks \- get a list of link-layer header
  25 types supported by a capture device, and free that list
  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 void pcap_free_datalinks(int *dlt_list);
  35 .ft
  36 .fi
  37 .SH DESCRIPTION
  38 .B pcap_list_datalinks()
  39 is used to get a list of the supported link-layer header types of the
  40 interface associated with the pcap descriptor.
  41 .B pcap_list_datalinks()
  42 allocates an array to hold the list and sets
  43 .IR *dlt_buf
  44 to point to that array.
  45 .LP
  46 The caller is responsible for freeing the array with
  47 .BR pcap_free_datalinks() ,
  48 which frees the list of link-layer header types pointed to by
  49 .IR dlt_list .
  50 .SH RETURN VALUE
  51 .B pcap_list_datalinks()
  52 returns the number of link-layer header types in the array on success
  53 and \-1 on failure.
  54 If \-1 is returned,
  55 .B pcap_geterr()
  56 or
  57 .B pcap_perror()
  58 may be called with
  59 .I p
  60 as an argument to fetch or display the error text.
  61 .SH SEE ALSO
  62 pcap(3PCAP), pcap_geterr(3PCAP),
  63 pcap_datalink_val_to_name(3PCAP),
  64 pcap-linktype(@MAN_MISC_INFO@)