contrib/libpcap/pcap_set_datalink.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_SET_DATALINK 3PCAP "25 July 2018"
  21 .SH NAME
  22 pcap_set_datalink \- set the link-layer header type to be used by a
  23 capture device
  24 .SH SYNOPSIS
  25 .nf
  26 .ft B
  27 #include <pcap/pcap.h>
  28 .ft
  29 .LP
  30 .ft B
  31 int pcap_set_datalink(pcap_t *p, int dlt);
  32 .ft
  33 .fi
  34 .SH DESCRIPTION
  35 .B pcap_set_datalink()
  36 is used to set the current link-layer header type of the pcap descriptor
  37 to the type specified by
  38 .IR dlt .
  39 .SH RETURN VALUE
  40 .B pcap_set_datalink()
  41 returns 0 on success and
  42 .B PCAP_ERROR
  43 on failure. If
  44 .B PCAP_ERROR
  45 is returned,
  46 .B pcap_geterr(3PCAP)
  47 or
  48 .B pcap_perror(3PCAP)
  49 may be called with
  50 .I p
  51 as an argument to fetch or display the error text.
  52 .SH SEE ALSO
  53 pcap(3PCAP), pcap_datalink_name_to_val(3PCAP)